Skip to content

encourage separate .bzl files for separate symbols #28070

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
benjaminp wants to merge 1 commit into
base: master
Choose a base branch
from
Open

encourage separate .bzl files for separate symbols #28070

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 10 additions & 7 deletions site/en/rules/deploying.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,8 @@ For example, when writing new rules for the (make-believe)
BUILD
runfiles.mocs
BUILD
defs.bzl
mockascript_library.bzl
mockascript_binary.bzl
tests/
BUILD
some_test.sh
Expand Down Expand Up @@ -96,16 +97,17 @@ of your ruleset, and the API users should expect.
### Rules

Often times there will be multiple rules provided by your repository. Create a
directory named by the language and provide an entry point - `defs.bzl` file
exporting all rules (also include a `BUILD` file so the directory is a package).
For `rules_mockascript` that means there will be a directory named
`mockascript`, and a `BUILD` file and a `defs.bzl` file inside:
directory named by the language and provide your public rules and macros in
individual `.bzl` files. This keeps your definitions granular and allows users
to avoid loading every symbol if they only need a subset. Also include a `BUILD`
file so the directory is a package.

```
/
mockascript/
BUILD
defs.bzl
mockascript_binary.bzl
mockascript_library.bzl
```

### Constraints
Expand All @@ -122,7 +124,8 @@ directory structure will look like this:
constraints/
BUILD
BUILD
defs.bzl
mockascript_binary.bzl
mockascript_library.bzl
```

Please read
Expand Down