bazel
/
bazel-lib
mirror of https://github.com/bazel-contrib/bazel-lib
2
0
Fork 0
Code Issues Releases Activity

docs: add a note about excluding from linters/formatters (#156)

This commit is contained in:
David 2022-06-24 12:30:08 -07:00 committed by GitHub
parent df04df7cd2
commit f08952a8a6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/write_source_files.md generated
View File

@ -80,6 +80,8 @@ To update *only* this file, run:
If you have many sources that you want to update as a group, we recommend wrapping write_source_files in a macro that defaults `suggested_update_target` to the umbrella update target.
NOTE: If you run formatters or linters on your codebase, it is advised that you exclude/ignore the outputs of this rule from those formatters/linters so as to avoid causing collisions and failing tests.
**PARAMETERS**

2
lib/write_source_files.bzl
View File

@ -80,6 +80,8 @@ def write_source_files(
```
If you have many sources that you want to update as a group, we recommend wrapping write_source_files in a macro that defaults `suggested_update_target` to the umbrella update target.
NOTE: If you run formatters or linters on your codebase, it is advised that you exclude/ignore the outputs of this rule from those formatters/linters so as to avoid causing collisions and failing tests.
Args:
name: Name of the executable target that creates or updates the source file