bazelbuild / bazelbuild/bazel

configuration_field needs a warning not to use and a link to an example of using build settings

Open
#11,309 6 comments 1 reaction 0 assignees View on GitHub
help wanted P3 team-Configurability team-Documentation type: documentation (cleanup)
Dominant language
Java
Stars
25.8k
Forks
4.6k
Avg merge
2d 18h
Merged PRs (30d)
75

Description

https://docs.bazel.build/versions/3.1.0/skylark/lib/globals.html#configuration_field

We need a longer example of use. It should be put in https://github.com/bazelbuild/examples/tree/master/rules with a link in the documentation (so that we can easily test and maintain the snippet).

Contributor guide

Open the contributing guide

Research direction

Start with the configuration_field page at docs.bazel.build and inspect the examples/rules directory in bazelbuild/examples. Done means adding the requested warning and documentation link, plus a longer maintainable example in the examples repository that demonstrates using build settings.

Written by the indexing model from the issue text.

Assessment

Domain
build-system, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.