This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Bazel shell worker

Rules for the bazel shell worker

1 - al_genrule

al_genrule

load("@com_alwaldend_src//bzl/rules/bazel_shell_worker:al_genrule.bzl", "al_genrule")

al_genrule(test, executable, **kwargs)

Generate al_genrule target

PARAMETERS

Name Description Default Value
test If set, use al_genrule_test False
executable if set, use al_genrule_executable False
kwargs kwargs for the rule none

2 - al_genrule_rule

al_genrule_executable

load("@com_alwaldend_src//bzl/rules/bazel_shell_worker:al_genrule_rule.bzl", "al_genrule_executable")

al_genrule_executable(name, srcs, data, outs, cmd, set_flags, shell, tools, worker)

Build executable using shell worker

ATTRIBUTES

Name Description Type Mandatory Default
name A unique name for this target. Name required
srcs Sources, will not be added to runfiles List of labels optional []
data Data, will be added to runfiles List of labels optional []
outs Outputs List of labels; nonconfigurable required
cmd Script to execute String required
set_flags set flags List of strings optional ["-eux"]
shell shell to use String optional "/bin/sh"
tools Tools, will be added to runfiles List of labels optional []
worker Worker binary Label optional "@com_alwaldend_src//go/bazel-shell-worker"

al_genrule_regular

load("@com_alwaldend_src//bzl/rules/bazel_shell_worker:al_genrule_rule.bzl", "al_genrule_regular")

al_genrule_regular(name, srcs, data, outs, cmd, set_flags, shell, tools, worker)

Build shell worker rule

ATTRIBUTES

Name Description Type Mandatory Default
name A unique name for this target. Name required
srcs Sources, will not be added to runfiles List of labels optional []
data Data, will be added to runfiles List of labels optional []
outs Outputs List of labels; nonconfigurable required
cmd Script to execute String required
set_flags set flags List of strings optional ["-eux"]
shell shell to use String optional "/bin/sh"
tools Tools, will be added to runfiles List of labels optional []
worker Worker binary Label optional "@com_alwaldend_src//go/bazel-shell-worker"

al_genrule_test

load("@com_alwaldend_src//bzl/rules/bazel_shell_worker:al_genrule_rule.bzl", "al_genrule_test")

al_genrule_test(name, srcs, data, outs, cmd, set_flags, shell, tools, worker)

Test using shell worker

ATTRIBUTES

Name Description Type Mandatory Default
name A unique name for this target. Name required
srcs Sources, will not be added to runfiles List of labels optional []
data Data, will be added to runfiles List of labels optional []
outs Outputs List of labels; nonconfigurable required
cmd Script to execute String required
set_flags set flags List of strings optional ["-eux"]
shell shell to use String optional "/bin/sh"
tools Tools, will be added to runfiles List of labels optional []
worker Worker binary Label optional "@com_alwaldend_src//go/bazel-shell-worker"

3 - Bazel targets

NameInfo
al_genrule
locationbzl/rules/bazel_shell_worker/BUILD.bazel:11:19
name//bzl/rules/bazel_shell_worker:al_genrule
ruleClassbzl_library
visibility
  • //visibility:public
al_genrule.stardoc
locationbzl/rules/bazel_shell_worker/BUILD.bazel:11:19
name//bzl/rules/bazel_shell_worker:al_genrule.stardoc
ruleClassgenrule
ruleOutput
  • //bzl/rules/bazel_shell_worker:al_genrule.stardoc.md
visibility
  • //visibility:private
al_genrule.stardoc_raw
locationbzl/rules/bazel_shell_worker/BUILD.bazel:11:19
name//bzl/rules/bazel_shell_worker:al_genrule.stardoc_raw
ruleClassstardoc_markdown_renderer
ruleOutput
  • //bzl/rules/bazel_shell_worker:al_genrule.stardoc_raw.md
visibility
  • //visibility:private
al_genrule.stardoc_raw.extract
locationbzl/rules/bazel_shell_worker/BUILD.bazel:11:19
name//bzl/rules/bazel_shell_worker:al_genrule.stardoc_raw.extract
ruleClassstarlark_doc_extract
ruleOutput
  • //bzl/rules/bazel_shell_worker:al_genrule.stardoc_raw.extract.binaryproto
  • //bzl/rules/bazel_shell_worker:al_genrule.stardoc_raw.extract.textproto
visibility
  • //visibility:private
al_genrule_rule
locationbzl/rules/bazel_shell_worker/BUILD.bazel:11:19
name//bzl/rules/bazel_shell_worker:al_genrule_rule
ruleClassbzl_library
visibility
  • //visibility:public
al_genrule_rule.stardoc
locationbzl/rules/bazel_shell_worker/BUILD.bazel:11:19
name//bzl/rules/bazel_shell_worker:al_genrule_rule.stardoc
ruleClassgenrule
ruleOutput
  • //bzl/rules/bazel_shell_worker:al_genrule_rule.stardoc.md
visibility
  • //visibility:private
al_genrule_rule.stardoc_raw
locationbzl/rules/bazel_shell_worker/BUILD.bazel:11:19
name//bzl/rules/bazel_shell_worker:al_genrule_rule.stardoc_raw
ruleClassstardoc_markdown_renderer
ruleOutput
  • //bzl/rules/bazel_shell_worker:al_genrule_rule.stardoc_raw.md
visibility
  • //visibility:private
al_genrule_rule.stardoc_raw.extract
locationbzl/rules/bazel_shell_worker/BUILD.bazel:11:19
name//bzl/rules/bazel_shell_worker:al_genrule_rule.stardoc_raw.extract
ruleClassstarlark_doc_extract
ruleOutput
  • //bzl/rules/bazel_shell_worker:al_genrule_rule.stardoc_raw.extract.binaryproto
  • //bzl/rules/bazel_shell_worker:al_genrule_rule.stardoc_raw.extract.textproto
visibility
  • //visibility:private
changelog
locationbzl/rules/bazel_shell_worker/BUILD.bazel:6:17
name//bzl/rules/bazel_shell_worker:changelog
ruleClasspkg_filegroup
visibility
  • //visibility:public
changelog.changelog
locationbzl/rules/bazel_shell_worker/BUILD.bazel:6:17
name//bzl/rules/bazel_shell_worker:changelog.changelog
ruleClassal_template_files
ruleOutput
  • //bzl/rules/bazel_shell_worker:changelog.doc.md
visibility
  • //visibility:private
changelog.changelog_data
locationbzl/rules/bazel_shell_worker/BUILD.bazel:6:17
name//bzl/rules/bazel_shell_worker:changelog.changelog_data
ruleClassal_git_run_binary
ruleOutput
  • //bzl/rules/bazel_shell_worker:changelog.changelog_data.yaml
visibility
  • //visibility:private
changelog.changelog_files
locationbzl/rules/bazel_shell_worker/BUILD.bazel:6:17
name//bzl/rules/bazel_shell_worker:changelog.changelog_files
ruleClasspkg_files
visibility
  • //visibility:private
changelog.template
locationbzl/rules/bazel_shell_worker/BUILD.bazel:6:17
name//bzl/rules/bazel_shell_worker:changelog.template
ruleClass_write_file
ruleOutput
  • //bzl/rules/bazel_shell_worker:changelog.template.md
visibility
  • //visibility:private
libs
locationbzl/rules/bazel_shell_worker/BUILD.bazel:11:19
name//bzl/rules/bazel_shell_worker:libs
ruleClassbzl_library
visibility
  • //visibility:public
libs.stardoc
locationbzl/rules/bazel_shell_worker/BUILD.bazel:11:19
name//bzl/rules/bazel_shell_worker:libs.stardoc
ruleClasspkg_filegroup
visibility
  • //visibility:public
libs.stardoc_src
locationbzl/rules/bazel_shell_worker/BUILD.bazel:11:19
name//bzl/rules/bazel_shell_worker:libs.stardoc_src
ruleClasspkg_files
visibility
  • //visibility:private
readme
locationbzl/rules/bazel_shell_worker/BUILD.bazel:22:10
name//bzl/rules/bazel_shell_worker:readme
ruleClassfilegroup
visibility
  • //visibility:public
readme.srcs
locationbzl/rules/bazel_shell_worker/BUILD.bazel:22:10
name//bzl/rules/bazel_shell_worker:readme.srcs
ruleClasspkg_files
visibility
  • //visibility:private
readme.with_children
locationbzl/rules/bazel_shell_worker/BUILD.bazel:22:10
name//bzl/rules/bazel_shell_worker:readme.with_children
ruleClasspkg_filegroup
visibility
  • //visibility:public

4 - Changelog

  • Move changelog rules to bzl/rules/git, improve ansible rules (c94123)
  • Move changelog rules to bzl/rules/changelog (4d59d6)
  • Move readme rules to bzl/rules/readme (95ea8d)
  • Move bzl rules to bzl/rules/bzl (57930e)
  • Move bazel shell worker rules to bzl/rules/bazel_shell_worker (0a9c1c)