mirror of
https://github.com/bazelbuild/bazel-skylib
synced 2024-11-29 09:35:55 +00:00
2d1669ed88
This PR adds two new rules: write_file and write_xfile. Both rules solve a common problem: to write a text file with user-defined contents. The problem is routinely solved using a genrule. That however requires Bash, since genrules execute Bash commands. Requiring Bash is a problem on Windows. The new rules do not require any shell. The only difference between the rules is that write_xfile creates an executable file while write_file doesn't. See https://github.com/bazelbuild/bazel/issues/4319
31 lines
1.1 KiB
Python
31 lines
1.1 KiB
Python
# Copyright 2019 The Bazel Authors. All rights reserved.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
"""A rule that writes a UTF-8 encoded text file from user-specified contents.
|
|
|
|
native.genrule() is sometimes used to create a text file. The 'write_file' and
|
|
macro does this with a simpler interface than genrule.
|
|
|
|
The rules generated by the macro do not use Bash or any other shell to write the
|
|
file. Instead they use Starlark's built-in file writing action
|
|
(ctx.actions.write).
|
|
"""
|
|
|
|
load(
|
|
":write_file_private.bzl",
|
|
_write_file = "write_file",
|
|
)
|
|
|
|
write_file = _write_file
|