Skip to content
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

docs: add use_default_shell_env to docstring of run_binary #778

Merged
merged 1 commit into from
Mar 5, 2024
Merged

docs: add use_default_shell_env to docstring of run_binary #778

Show file tree
Hide file tree
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
3 changes: 2 additions & 1 deletion docs/run_binary.md
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions lib/private/run_binary.bzl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,7 @@ def run_binary(
mnemonic = "RunBinary",
progress_message = None,
execution_requirements = None,
use_default_shell_env = False,
stamp = 0,
**kwargs):
"""Runs a binary as a build action.
Expand Down Expand Up @@ -180,6 +181,10 @@ def run_binary(

See https://docs.bazel.build/versions/main/be/common-definitions.html#common.tags for useful keys.

use_default_shell_env: Passed to the underlying ctx.actions.run.

See https://bazel.build/rules/lib/builtins/actions#run for more details.

stamp: Whether to include build status files as inputs to the tool. Possible values:

- `stamp = 0` (default): Never include build status files as inputs to the tool.
Expand Down Expand Up @@ -215,6 +220,7 @@ def run_binary(
mnemonic = mnemonic,
progress_message = progress_message,
execution_requirements = execution_requirements,
use_default_shell_env = use_default_shell_env,
stamp = stamp,
**kwargs
)
Loading