bazelbuild/bazel

Clarify where repository rules should be defined

Open

#8,941 opened on Jul 20, 2019

View on GitHub
 (0 comments) (1 reaction) (0 assignees)Java (4,465 forks)batch import
P3help wantedteam-Documentationteam-ExternalDepstype: documentation (cleanup)

Repository metrics

Stars
 (25,384 stars)
PR merge metrics
 (Avg merge 22d 20h) (77 merged PRs in 30d)

Description

Description of the feature request:

Add wording in the Bazel rule deployment guidelines clarifying where repository rules should be defined: defs.bzl, repositories.bzl or elsewhere?

Feature requests: what underlying problem are you trying to solve with this feature?

Currently, the documentation says "rules" should be exposed in defs.bzl. There is a section titled "Repository rules", which one would expect says what to do about repository rules, but it only discusses introducing a single macro that defines all necessary dependencies. If I have a set of rules called rules_foo, which perhaps has a few build rules and several repository rules, it's unclear where the user should expect to find all the repository rules.

Contributor guide