Bzl_stardoc on Alwaldend

al_alias_map

Mon, 01 Jan 0001 00:00:00 +0000

al_alias_map

load("@com_alwaldend_src//tools/bzl/main/bzl:al_alias_map.bzl", "al_alias_map")

al_alias_map(aliases, visibility)

Generate aliases from an alias map

PARAMETERS

Name	Description	Default Value
aliases	alias map, keys are names, values are alias arguments	none
visibility	default visibility	`["//:__subpackages__"]`

al_apply_patches

Mon, 01 Jan 0001 00:00:00 +0000

al_apply_patches

load("@com_alwaldend_src//tools/patch/main/bzl:al_apply_patches.bzl", "al_apply_patches")

al_apply_patches(name, src, patches, visibility, **kwargs)

Create a genrule applying patches

PARAMETERS

Name	Description	Default Value
name	genrule name	none
src	source archive label	none
patches	patches label	none
visibility	visibility	`["//:__subpackages__"]`
kwargs	other genrule kwargs	none

al_bzl_generate_repository

Mon, 01 Jan 0001 00:00:00 +0000

al_bzl_generate_repository

load("@com_alwaldend_src//tools/bzl/main/bzl:al_bzl_generate_repository.bzl", "al_bzl_generate_repository")

al_bzl_generate_repository(name, files, repo_mapping)

Generate a repository

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this repository.	Name	required
files	Files to generate, keys are paths, values are file contents	Dictionary: String -> String	optional	`{}`
repo_mapping	In `WORKSPACE` context only: a dictionary from local repository name to global repository name. This allows controls over workspace dependency resolution for dependencies of this repository. For example, an entry `"@foo": "@bar"` declares that, for any time this repository depends on `@foo` (such as a dependency on `@foo//some:target`, it should actually resolve that dependency within globally-declared `@bar` (`@bar//some:target`). This attribute is not supported in `MODULE.bazel` context (when invoking a repository rule inside a module extension’s implementation function).	Dictionary: String -> String	optional

al_bzl_library_map

Mon, 01 Jan 0001 00:00:00 +0000

al_bzl_library_map

load("@com_alwaldend_src//tools/bzl/main/bzl:al_bzl_library_map.bzl", "al_bzl_library_map")

al_bzl_library_map(name, visibility, libs, deps, **kwargs)

Create bzl_library targets from a map

PARAMETERS

Name	Description	Default Value
name	combined bzl_library target name	none
visibility	-	`None`
libs	bzl_library names	`{}`
deps	other al_bzl_library_map targets	`[]`
kwargs	bzl_library kwargs	none

al_bzl_target_doc

Mon, 01 Jan 0001 00:00:00 +0000

al_bzl_target_doc

load("@com_alwaldend_src//tools/bzl/main/bzl:al_bzl_target_doc.bzl", "al_bzl_target_doc")

al_bzl_target_doc(name, visibility, subpackages)

Document bazel targets

PARAMETERS

Name	Description	Default Value
name	target name	none
visibility	-	none
subpackages	list of subpackages	`[]`

al_bzlenv_binary

Mon, 01 Jan 0001 00:00:00 +0000

al_bzlenv_binary

load("@com_alwaldend_src//tools/bzlenv/main/bzl:al_bzlenv_binary.bzl", "al_bzlenv_binary")

al_bzlenv_binary(name, activate, tools)

Dev shell binary

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this target.	Name	required
activate	Activation script	Label	optional	`"@com_alwaldend_src//tools/bzlenv/main/sh:activate"`
tools	Tools, keys are tool names, values are tool labels	Dictionary: String -> Label	optional	`{}`

al_combine_files

Mon, 01 Jan 0001 00:00:00 +0000

al_combine_files

load("@com_alwaldend_src//tools/txt/main/bzl:al_combine_files.bzl", "al_combine_files")

al_combine_files(name, srcs, **kwargs)

Create a genrule combining several files into one

PARAMETERS

Name	Description	Default Value
name	genrule target	none
srcs	list of labels to combine	none
kwargs	other genrule kwargs	none

al_compile_pip_requirements_combined

Mon, 01 Jan 0001 00:00:00 +0000

al_compile_pip_requirements_combined

load("@com_alwaldend_src//tools/py/main/bzl:al_compile_pip_requirements_combined.bzl", "al_compile_pip_requirements_combined")

al_compile_pip_requirements_combined(name, srcs, **kwargs)

Create compile_pip_requirements target for several requirement files

PARAMETERS

Name	Description	Default Value
name	compile_pip_requirements name	none
srcs	list of labels of requirement files to combine	none
kwargs	kwargs for `compile_pip_requirements`	none

al_config

Mon, 01 Jan 0001 00:00:00 +0000

al_config

load("@com_alwaldend_src//projects/al/rules/al:al_config.bzl", "al_config")

al_config(name, deps, srcs, data)

Dump al config

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this target.	Name	required
deps	Al configs (targets)	List of labels	optional	`[]`
srcs	Al configs (source files)	List of labels	optional	`[]`
data	Data	List of labels	optional	`[]`

AlConfigInfo

load("@com_alwaldend_src//projects/al/rules/al:al_config.bzl", "AlConfigInfo")

AlConfigInfo(config)

Config info

FIELDS

Name	Description
config	Merged config file

al_drawio_run_binary

Mon, 01 Jan 0001 00:00:00 +0000

al_drawio_run_binary

load("@com_alwaldend_src//tools/drawio/main/bzl:al_drawio_run_binary.bzl", "al_drawio_run_binary")

al_drawio_run_binary(name, srcs, out, arguments, cmd_timeout)

Run drawio a a build action

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this target.	Name	required
srcs	Sources	List of labels	optional	`[]`
out	Output	Label; nonconfigurable	required
arguments	Arguments, location statements are expanded	List of strings	required
cmd_timeout	Drawio command timeout	String	optional	`"1m"`

al_drawio_toolchain

Mon, 01 Jan 0001 00:00:00 +0000

al_drawio_toolchain

load("@com_alwaldend_src//tools/drawio/main/bzl:al_drawio_toolchain.bzl", "al_drawio_toolchain")

al_drawio_toolchain(name, drawio)

Drawio toolchain

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this target.	Name	required
drawio	Drawio binary	Label	required

al_genquery_write_to_source_file

Mon, 01 Jan 0001 00:00:00 +0000

al_genquery_write_to_source_file

load("@com_alwaldend_src//tools/bzl/main/bzl:al_genquery_write_to_source_file.bzl", "al_genquery_write_to_source_file")

al_genquery_write_to_source_file(name, expression, scope, var_name, out_file)

Write genquery result to a bzl file

Example:

    al_genquery_write_to_source_file(
        name = "al_bzl_libs",
        expression = """
            filter(
                "^//",
                attr(
                    "srcs",
                    ".{3,}",
                    kind(
                        "bzl_library",
                        deps("//bzl")
                    )
                )
            )
        """,
        out_file = "al_bzl_libs.bzl",
        scope = ["//bzl"],
        var_name = "AL_BZL_LIBS",
    )

PARAMETERS

Name	Description	Default Value
name	name prefix	none
expression	genquery expression	none
scope	genquery scope	none
var_name	variable name in the generated .bzl file	none
out_file	output bzl file	none

al_genrule

Mon, 01 Jan 0001 00:00:00 +0000

al_genrule

load("@com_alwaldend_src//tools/shell_worker/main/bzl: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

al_genrule_rule

Mon, 01 Jan 0001 00:00:00 +0000

al_genrule_executable

load("@com_alwaldend_src//tools/shell_worker/main/bzl: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//tools/shell_worker"`

al_genrule_src

Mon, 01 Jan 0001 00:00:00 +0000

al_genrule_src

load("@com_alwaldend_src//tools/pkg/main/bzl:al_genrule_src.bzl", "al_genrule_src")

al_genrule_src(name, srcs, visibility)

Create a filegroup and a genrule generating a tar archive

PARAMETERS

Name	Description	Default Value
name	genrule name	none
srcs	source labels	`[]`
visibility	-	`["//:__subpackages"]`

al_genrule_with_wheels

Mon, 01 Jan 0001 00:00:00 +0000

al_genrule_with_wheels

load("@com_alwaldend_src//tools/py/main/bzl:al_genrule_with_wheels.bzl", "al_genrule_with_wheels")

al_genrule_with_wheels(name, wheels, srcs, cmd, **kwargs)

Regular genrule with wheels added to ${PYTHONPATH}

PARAMETERS

Name	Description	Default Value
name	genrule name	none
wheels	list of wheel labels	none
srcs	srcs for the genrule	`[]`
cmd	genrule cmd	`[]`
kwargs	other genrule kwargs	none

al_git_binary

Mon, 01 Jan 0001 00:00:00 +0000

al_git_binary

load("@com_alwaldend_src//tools/git/main/bzl:al_git_binary.bzl", "al_git_binary")

al_git_binary(name, arguments)

Run git binary

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this target.	Name	required
arguments	Git arguments (templated)	List of strings	optional	`[]`

al_git_changelog

Mon, 01 Jan 0001 00:00:00 +0000

al_git_changelog

load("@com_alwaldend_src//tools/git/main/bzl:al_git_changelog.bzl", "al_git_changelog")

al_git_changelog(name, visibility, git_binary, subpackages)

Create changelog target

PARAMETERS

Name	Description	Default Value
name	target name prefix	none
visibility	visibility	none
git_binary	-	`"@git//:git"`
subpackages	subpackages	`[]`

al_git_current_state

Mon, 01 Jan 0001 00:00:00 +0000

al_git_extension

Mon, 01 Jan 0001 00:00:00 +0000

al_git_extension

al_git_extension = use_extension("@com_alwaldend_src//tools/git/main/bzl:al_git_extension.bzl", "al_git_extension")
al_git_extension.local_git(name)

Create git repos

TAG CLASSES

local_git

Attributes

Name	Description	Type	Mandatory	Default
name	Name	Name	required

al_git_info_file

Mon, 01 Jan 0001 00:00:00 +0000

al_git_info_file

load("@com_alwaldend_src//tools/git/main/bzl:al_git_info_file.bzl", "al_git_info_file")

al_git_info_file(name, git_state, git_tool, timeout)

Generate git info file

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this target.	Name	required
git_state	Files that should invalidate the cache on new commit	List of labels	optional	`[]`
git_tool	Git tool to use	Label	optional	`"@com_alwaldend_src//tools/git/main/go"`
timeout	Timeout in seconds	Integer	optional	`60`

al_git_repo

Mon, 01 Jan 0001 00:00:00 +0000

al_git_repo

load("@com_alwaldend_src//tools/git/main/bzl:al_git_repo.bzl", "al_git_repo")

al_git_repo(name, repo_mapping)

Git repo

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this repository.	Name	required
repo_mapping	In `WORKSPACE` context only: a dictionary from local repository name to global repository name. This allows controls over workspace dependency resolution for dependencies of this repository. For example, an entry `"@foo": "@bar"` declares that, for any time this repository depends on `@foo` (such as a dependency on `@foo//some:target`, it should actually resolve that dependency within globally-declared `@bar` (`@bar//some:target`). This attribute is not supported in `MODULE.bazel` context (when invoking a repository rule inside a module extension’s implementation function).	Dictionary: String -> String	optional

al_git_resolved_toolchain

Mon, 01 Jan 0001 00:00:00 +0000

al_git_resolved_toolchain

load("@com_alwaldend_src//tools/git/main/bzl:al_git_resolved_toolchain.bzl", "al_git_resolved_toolchain")

al_git_resolved_toolchain(name)

Resolved git toolchain

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this target.	Name	required

al_git_run_binary

Mon, 01 Jan 0001 00:00:00 +0000

al_git_run_binary

load("@com_alwaldend_src//tools/git/main/bzl:al_git_run_binary.bzl", "al_git_run_binary")

al_git_run_binary(name, srcs, outs, arguments, git)

Run a git binary as a build action

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this target.	Name	required
srcs	Files to be made available	List of labels	optional	`[]`
outs	Outputs	List of labels; nonconfigurable	required
arguments	Arguments (Location is expanded)	List of strings	optional	`[]`
git	Git binary	Label	required

al_git_toolchain

Mon, 01 Jan 0001 00:00:00 +0000

al_git_toolchain

load("@com_alwaldend_src//tools/git/main/bzl:al_git_toolchain.bzl", "al_git_toolchain")

al_git_toolchain(name, git_dir, git_path, git_root, invalidation)

Local git toolchain

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this target.	Name	required
git_dir	Git directory path	String	required
git_path	Git binary path	String	required
git_root	Git workspace path	String	required
invalidation	Files that should invalidate git actions	List of labels	optional	`[]`

al_go_repository

Mon, 01 Jan 0001 00:00:00 +0000

al_go_repository

al_go_repository = use_extension("@com_alwaldend_src//tools/go/main/bzl:al_go_repository.bzl", "al_go_repository")
al_go_repository.go_repository(name, importpath, sum, version)

Extension wrapper around go_repository (useless because you can just call use_repo_rule)

TAG CLASSES

go_repository

Attributes

Name	Description	Type	Mandatory	Default
name	Name	Name	required
importpath	importpath	String	required
sum	checksum	String	optional	`""`
version	-	String	required

al_gzip_extension

Mon, 01 Jan 0001 00:00:00 +0000

al_gzip_extension

al_gzip_extension = use_extension("@com_alwaldend_src//tools/gzip/main/bzl:al_gzip_extension.bzl", "al_gzip_extension")
al_gzip_extension.download(name, integrity, url)

Extension for gzip repos

TAG CLASSES

download

Attributes

Name	Description	Type	Mandatory	Default
name	Name	Name	required
integrity	Integrity	String	optional	`""`
url	Url	String	required

al_gzip_repo

Mon, 01 Jan 0001 00:00:00 +0000

al_gzip_repo

load("@com_alwaldend_src//tools/gzip/main/bzl:al_gzip_repo.bzl", "al_gzip_repo")

al_gzip_repo(name, integrity, repo_mapping, url)

Gzip repo

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this repository.	Name	required
integrity	Integrity	String	optional	`""`
repo_mapping	In `WORKSPACE` context only: a dictionary from local repository name to global repository name. This allows controls over workspace dependency resolution for dependencies of this repository. For example, an entry `"@foo": "@bar"` declares that, for any time this repository depends on `@foo` (such as a dependency on `@foo//some:target`, it should actually resolve that dependency within globally-declared `@bar` (`@bar//some:target`). This attribute is not supported in `MODULE.bazel` context (when invoking a repository rule inside a module extension’s implementation function).	Dictionary: String -> String	optional
url	Url	String	required

al_helm_binary

Mon, 01 Jan 0001 00:00:00 +0000

al_helm_binary

load("@com_alwaldend_src//tools/helm/main/bzl:al_helm_binary.bzl", "al_helm_binary")

al_helm_binary(name, data, arguments, cd)

Helm binary

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this target.	Name	required
data	Helm chart	List of labels	optional	`[]`
arguments	Helm arguments	List of strings	optional	`[]`
cd	Cd to a directory before running bazel	String	optional	`"."`

al_helm_chart

Mon, 01 Jan 0001 00:00:00 +0000

al_helm_chart

load("@com_alwaldend_src//tools/helm/main/bzl:al_helm_chart.bzl", "al_helm_chart")

al_helm_chart(name, deps, package, source)

Helm chart

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this target.	Name	required
deps	Helm chart deps	List of labels	optional	`[]`
package	Helm chart package	Label	optional	`None`
source	Helm chart source	Label	optional	`None`

al_helm_chart_info

Mon, 01 Jan 0001 00:00:00 +0000

AlHelmChartInfo

load("@com_alwaldend_src//tools/helm/main/bzl:al_helm_chart_info.bzl", "AlHelmChartInfo")

AlHelmChartInfo(source, package, deps, files_info)

Information about a helm chart

FIELDS

Name	Description
source	Chart sources (PackageFilegroupInfo, optional)
package	Chart package (tgz file)
deps	Chart deps (depset of AlHelmChartInfo)
files_info	Chart file structure (PackageFilesInfo)

al_helm_chart_lock

Mon, 01 Jan 0001 00:00:00 +0000

al_helm_chart_lock

load("@com_alwaldend_src//tools/helm/main/bzl:al_helm_chart_lock.bzl", "al_helm_chart_lock")

al_helm_chart_lock(name, lock, lock_out)

Generate targets for a chart lock

PARAMETERS

Name	Description	Default Value
name	name	none
lock	lock label	none
lock_out	parsed lock filename	none

al_helm_cmds

Mon, 01 Jan 0001 00:00:00 +0000

al_helm_deps

Mon, 01 Jan 0001 00:00:00 +0000

al_helm_deps

al_helm_deps = use_extension("@com_alwaldend_src//tools/helm/main/bzl:al_helm_deps.bzl", "al_helm_deps")
al_helm_deps.from_locks(name, integrity, locks)

Extension to download helm dependencies

TAG CLASSES

from_locks

Attributes

Name	Description	Type	Mandatory	Default
name	Repo name	Name	required
integrity	Intergrity for locks, keys are packages, values are integrity	Dictionary: String -> String	optional	`{}`
locks	Helm lock labels	List of labels	optional	`[]`

al_helm_deps_repo

Mon, 01 Jan 0001 00:00:00 +0000

al_helm_deps_repo

load("@com_alwaldend_src//tools/helm/main/bzl:al_helm_deps_repo.bzl", "al_helm_deps_repo")

al_helm_deps_repo(name, integrity, locks, repo_mapping)

Helm deps repo

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this repository.	Name	required
integrity	Intergrity for locks, keys are packages, values are integrity	Dictionary: String -> String	optional	`{}`
locks	Lock labels to parse	List of labels	optional	`[]`
repo_mapping	In `WORKSPACE` context only: a dictionary from local repository name to global repository name. This allows controls over workspace dependency resolution for dependencies of this repository. For example, an entry `"@foo": "@bar"` declares that, for any time this repository depends on `@foo` (such as a dependency on `@foo//some:target`, it should actually resolve that dependency within globally-declared `@bar` (`@bar//some:target`). This attribute is not supported in `MODULE.bazel` context (when invoking a repository rule inside a module extension’s implementation function).	Dictionary: String -> String	optional

al_helm_toolchain

Mon, 01 Jan 0001 00:00:00 +0000

al_helm_toolchain

load("@com_alwaldend_src//tools/helm/main/bzl:al_helm_toolchain.bzl", "al_helm_toolchain")

al_helm_toolchain(name, helm)

Helm toolchain

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this target.	Name	required
helm	Helm binary	Label	required

al_http_server_binary

Mon, 01 Jan 0001 00:00:00 +0000

al_http_server_binary

load("@com_alwaldend_src//tools/http_server/main/bzl:al_http_server_binary.bzl", "al_http_server_binary")

al_http_server_binary(name, srcs, arguments)

Run a http server

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this target.	Name	required
srcs	Files to symlink	List of labels	optional	`[]`
arguments	Arguments	List of strings	optional	`[]`

al_install_file

Mon, 01 Jan 0001 00:00:00 +0000

al_install_file

load("@com_alwaldend_src//tools/install_file/main/bzl:al_install_file.bzl", "al_install_file")

al_install_file(name, args, install_file_label, visibility, **py_binary_kwargs)

Create py_binary target to install file

PARAMETERS

Name	Description	Default Value
name	target name	none
args	install-file args	`[]`
install_file_label	-	`"//tools/install_file/main/py:install_file_lib"`
visibility	-	`["//:__subpackages__"]`
py_binary_kwargs	-	none

al_leetcode_submissions

Mon, 01 Jan 0001 00:00:00 +0000

al_leetcode_submissions

load("@com_alwaldend_src//projects/leetcode_downloader/main/bzl:al_leetcode_submissions.bzl", "al_leetcode_submissions")

al_leetcode_submissions(name, srcs, visibility, **kwargs)

Generate leetcode submission targets

PARAMETERS

Name	Description	Default Value
name	generated md archive name	none
srcs	leetcode submission configs	none
visibility	visibility	`None`
kwargs	kwargs for template_files	none

al_lua_library

Mon, 01 Jan 0001 00:00:00 +0000

al_lua_library

load("@com_alwaldend_src//tools/lua/main/bzl:al_lua_library.bzl", "al_lua_library")

al_lua_library(name, srcs, check, stylua_config_label, stylua_label, pkg_kwargs, visibility)

Generate targets for a lua library

PARAMETERS

Name	Description	Default Value
name	library name	none
srcs	library sources	none
check	if set, only these files will be checked	`[]`
stylua_config_label	-	`"//tools/stylua:stylua_config"`
stylua_label	-	`"//tools/stylua"`
pkg_kwargs	-	`{}`
visibility	visibility	`["//:__subpackages__"]`

al_make_install

Mon, 01 Jan 0001 00:00:00 +0000

al_make_install

load("@com_alwaldend_src//tools/make_install/main/bzl:al_make_install.bzl", "al_make_install")

al_make_install(name, srcs)

Create the make install executable and a filegroup

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this target.	Name	required
srcs	Make install filegroups	List of labels	optional	`[]`

al_make_install_binary

Mon, 01 Jan 0001 00:00:00 +0000

al_make_install_binary

load("@com_alwaldend_src//tools/make_install/main/bzl:al_make_install_binary.bzl", "al_make_install_binary")

al_make_install_binary(name, src, arguments)

Create a binary target for a make install

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this target.	Name	required
src	Make install target	Label	required
arguments	Arugments for the executable	List of strings	optional	`[]`

al_make_install_filegroup

Mon, 01 Jan 0001 00:00:00 +0000

al_make_install_filegroup

load("@com_alwaldend_src//tools/make_install/main/bzl:al_make_install_filegroup.bzl", "al_make_install_filegroup")

al_make_install_filegroup(name, deps, srcs, diff_args, install_args, install_dir, pkg_prefix)

Create a make install filegroup

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this target.	Name	required
deps	Deps	List of labels	optional	`[]`
srcs	Sources to install	List of labels	optional	`[]`
diff_args	Diff args	List of strings	optional	`[]`
install_args	Install args	List of strings	optional	`["--compare", "-D"]`
install_dir	Install directory	String	optional	`"${HOME}"`
pkg_prefix	Ignore that prefix for srcs	String	required

al_make_install_filegroup_info

Mon, 01 Jan 0001 00:00:00 +0000

AlMakeInstallFilegroupInfo

load("@com_alwaldend_src//tools/make_install/main/bzl:al_make_install_filegroup_info.bzl", "AlMakeInstallFilegroupInfo")

AlMakeInstallFilegroupInfo(srcs, deps, install_dir, origin, install_args, diff_args, pkg_prefix)

Describe install info for a single filegrop

FIELDS

Name	Description
srcs	depset of PackageFilegroupInfo
deps	depset of AlMakeInstallFilegroupInfo
install_dir	Install directory
origin	Rule label
install_args	Args for the install command
diff_args	Args for the diff command
pkg_prefix	Ignore that prefix for srcs

al_md_data

Mon, 01 Jan 0001 00:00:00 +0000

al_md_data

load("@com_alwaldend_src//tools/md/main/bzl:al_md_data.bzl", "al_md_data")

al_md_data(name, srcs, deps, **kwargs)

Markdown data backed by a filegroup

Targets:

${name}: filegroup

PARAMETERS

Name	Description	Default Value
name	filegroup name	none
srcs	markdown files	none
deps	deps	`[]`
kwargs	filegroup kwargs	none

al_pkg_basic_naming

Mon, 01 Jan 0001 00:00:00 +0000

al_pkg_basic_naming

load("@com_alwaldend_src//tools/pkg/main/bzl:al_pkg_basic_naming.bzl", "al_pkg_basic_naming")

al_pkg_basic_naming(name, deps)

Variables for @rules_pkg

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this target.	Name	required
deps	Deps to merge	List of labels	optional	`[]`

al_pkg_extract_dir

Mon, 01 Jan 0001 00:00:00 +0000

al_pkg_extract_dir

load("@com_alwaldend_src//tools/pkg/main/bzl:al_pkg_extract_dir.bzl", "al_pkg_extract_dir")

al_pkg_extract_dir(name, src, out, arguments)

Extract an archive into a TreeArtifact

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this target.	Name	required
src	Archive to unpack	Label	required
out	Output directory name	String	optional	`""`
arguments	Additional arguments	List of strings	optional	`[]`

al_pkg_tar_combined

Mon, 01 Jan 0001 00:00:00 +0000

al_pkg_tar_combined

load("@com_alwaldend_src//tools/pkg/main/bzl:al_pkg_tar_combined.bzl", "al_pkg_tar_combined")

al_pkg_tar_combined(name, srcs, strip_components, **kwargs)

Create a genrule combining several tars into one

PARAMETERS

Name	Description	Default Value
name	genrule name	none
srcs	dicts tar archives ({“label”: “tar label”, “dir”: “target dir”})	`[]`
strip_components	value of –stip-components	`2`
kwargs	other genrule kwargs	none

al_print_deps

Mon, 01 Jan 0001 00:00:00 +0000

al_print_deps

load("@com_alwaldend_src//tools/print_deps/main/bzl:al_print_deps.bzl", "al_print_deps")

al_print_deps()

ASPECT ATTRIBUTES

Name	Type
deps	String

ATTRIBUTES

al_proto_docs

Mon, 01 Jan 0001 00:00:00 +0000

al_proto_docs

load("@com_alwaldend_src//tools/proto/main/bzl:al_proto_docs.bzl", "al_proto_docs")

al_proto_docs(name, src, prefix, visibility, renames)

Generate protobuf documentation

PARAMETERS

Name	Description	Default Value
name	name	none
src	protobuf source file	none
prefix	-	`None`
visibility	visibility	`None`
renames	-	`None`

al_py_binary_shell

Mon, 01 Jan 0001 00:00:00 +0000

al_py_binary_shell

load("@com_alwaldend_src//tools/py/main/bzl:al_py_binary_shell.bzl", "al_py_binary_shell")

al_py_binary_shell(name, deps, srcs, shell_type, shell_label, **kwargs)

Create a py_binary target that allows you to run commands in proper python environment

PARAMETERS

Name	Description	Default Value
name	target name	none
deps	py_binary deps	`[]`
srcs	py_binary srcs	`[]`
shell_type	${BAZEL_PYTHON_SHELL_TYPE}	`"python"`
shell_label	-	`"//tools/py/main/py:bazel_python_shell_lib"`
kwargs	other py_binary kwargs	none

al_py_checker

Mon, 01 Jan 0001 00:00:00 +0000

al_py_checker

load("@com_alwaldend_src//tools/py/main/bzl:al_py_checker.bzl", "al_py_checker")

al_py_checker(name, tool, args_bin, args_test, test_size, disable_fix, **kwargs)

Create -fix and -test targets for a python checker

PARAMETERS

Name	Description	Default Value
name	Name prefix	`None`
tool	Tool label	`None`
args_bin	Args for the binary target	`None`
args_test	Args for the test	`None`
test_size	-	`"small"`
disable_fix	If set, do not create fix target	`False`
kwargs	Kwargs for both targets	none

al_py_checkers

Mon, 01 Jan 0001 00:00:00 +0000

al_py_checkers

load("@com_alwaldend_src//tools/py/main/bzl:al_py_checkers.bzl", "al_py_checkers")

al_py_checkers(name, srcs, isort_label, black_label, mypy_label, flake8_label, pyproject_label)

Generate -fix and -test targets for python checkers

PARAMETERS

Name	Description	Default Value
name	-	none
srcs	list of source file labels	none
isort_label	-	`"//tools/isort"`
black_label	-	`"//tools/black"`
mypy_label	-	`"//tools/mypy"`
flake8_label	-	`"//tools/flake8"`
pyproject_label	-	`"//tools/py:pyproject"`

al_release

Mon, 01 Jan 0001 00:00:00 +0000

al_release

load("@com_alwaldend_src//tools/release/main/bzl:al_release.bzl", "al_release")

al_release(name, srcs, git_bundle, git_state, manifest, project, release_name, release_tool,
           root_prefix)

Rule describing a release

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this target.	Name	required
srcs	Sources	List of labels	optional	`[]`
git_bundle	Deterministic Git bundle used to generate release metadata	Label	optional	`"@com_alwaldend_src_tools_git//:release_git_state"`
git_state	Additional declared Git state used to generate release metadata	List of labels	optional	`[]`
manifest	Load manifest from a file instead of generating it from srcs	Label	optional	`None`
project	Project package_name	String	required
release_name	Release name	String	required
release_tool	Release tool	Label	optional	`"@com_alwaldend_src//tools/release/main/go"`
root_prefix	Root prefix	String	optional	`"content/docs"`

al_release_binary

Mon, 01 Jan 0001 00:00:00 +0000

al_release_binary

load("@com_alwaldend_src//tools/release/main/bzl:al_release_binary.bzl", "al_release_binary")

al_release_binary(name, srcs, arguments, cmd, oras, release_tool)

Release binary

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this target.	Name	required
srcs	Releases	List of labels	optional	`[]`
arguments	Arguments	List of strings	optional	`[]`
cmd	Cmd	String	optional	`"deploy"`
oras	Oras binary	Label	optional	`"@com_alwaldend_src//tools/oras"`
release_tool	Release tool	Label	optional	`"@com_alwaldend_src//tools/release/main/go"`

al_release_deployment

Mon, 01 Jan 0001 00:00:00 +0000

al_release_deployment

load("@com_alwaldend_src//tools/release/main/bzl:al_release_deployment.bzl", "al_release_deployment")

al_release_deployment(name, oci_repository)

Deployment info

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this target.	Name	required
oci_repository	OCI repository url	String	optional	`""`

al_release_deployment_info

Mon, 01 Jan 0001 00:00:00 +0000

AlReleaseDeploymentInfo

load("@com_alwaldend_src//tools/release/main/bzl:al_release_deployment_info.bzl", "AlReleaseDeploymentInfo")

AlReleaseDeploymentInfo(info, info_file)

Deployment info

FIELDS

Name	Description
info	Deployment info struct
info_file	Deployment info file

al_release_deps

Mon, 01 Jan 0001 00:00:00 +0000

al_release_deps

load("@com_alwaldend_src//tools/release/main/bzl:al_release_deps.bzl", "al_release_deps")

al_release_deps(name, srcs, visibility, **kwargs)

Generate a dependency diagram using genquery

PARAMETERS

Name	Description	Default Value
name	name	none
srcs	list of labels to generate deps for (should be full labels)	none
visibility	visibility	`None`
kwargs	kwargs for al_release_files	none

al_release_files

Mon, 01 Jan 0001 00:00:00 +0000

al_release_files

load("@com_alwaldend_src//tools/release/main/bzl:al_release_files.bzl", "al_release_files")

al_release_files(name, deps, srcs, deployments, ignore_suffixes, release_tool)

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this target.	Name	required
deps	Deps	List of labels	optional	`[]`
srcs	Sources	List of labels	optional	`[]`
deployments	Deployment info	List of labels	optional	`[]`
ignore_suffixes	Ignore src files ending with these suffixes	List of strings	optional	`[]`
release_tool	Release tool	Label	optional	`"@com_alwaldend_src//tools/release/main/go"`

al_release_files_info

Mon, 01 Jan 0001 00:00:00 +0000

AlReleaseFilesInfo

load("@com_alwaldend_src//tools/release/main/bzl:al_release_files_info.bzl", "AlReleaseFilesInfo")

AlReleaseFilesInfo(files, manifest)

Release files

FIELDS

Name	Description
files	File dict, keys are filenames, values are Files
manifest	Release manifest for srcs

al_release_info

Mon, 01 Jan 0001 00:00:00 +0000

AlReleaseInfo

load("@com_alwaldend_src//tools/release/main/bzl:al_release_info.bzl", "AlReleaseInfo")

AlReleaseInfo(release_name, project, files, manifest)

Release information

FIELDS

Name	Description
release_name	Release name (string)
project	Project subdir (string)
files	File dict, keys are filenames, values are Files
manifest	Release manifest (File)

al_repo_map

Mon, 01 Jan 0001 00:00:00 +0000

al_repo_map

al_repo_map = use_extension("@com_alwaldend_src//tools/repo_map/main/bzl:al_repo_map.bzl", "al_repo_map")
al_repo_map.download(name, build_file_content, build_file_native_binary, download_type, executable,
                     repos, strip_prefix)

Extension to create several repos from a map

TAG CLASSES

download

Attributes

Name	Description	Type	Mandatory	Default
name	Name	Name	required
build_file_content	Build file content	String	optional	`""`
build_file_native_binary	Args for a native binary build file	Dictionary: String -> String	optional	`{}`
download_type	Download type	String	optional	`"http_archive"`
executable	Field executable for http_file	Boolean	optional	`False`
repos	Map of repos	Dictionary: String -> List of strings	required
strip_prefix	Strip prefix	String	optional	`""`

al_resolved_toolchain

Mon, 01 Jan 0001 00:00:00 +0000

al_resolved_toolchain

load("@com_alwaldend_src//tools/resolved_toolchain/main/bzl:al_resolved_toolchain.bzl", "al_resolved_toolchain")

al_resolved_toolchain(toolchain_label, **kwargs)

Create a resolved toolchain

PARAMETERS

Name	Description	Default Value
toolchain_label	-	none
kwargs	rule kwargs	none

RETURNS

Resolved toolchain rule

al_rfc_extension

Mon, 01 Jan 0001 00:00:00 +0000

al_rfc_extension

al_rfc_extension = use_extension("@com_alwaldend_src//tools/rfc/main/bzl:al_rfc_extension.bzl", "al_rfc_extension")
al_rfc_extension.download(name, integrity, rfcs)

Rfc extension

TAG CLASSES

download

Attributes

Name	Description	Type	Mandatory	Default
name	Name	Name	required
integrity	Rfc integrity	Dictionary: String -> String	optional	`{}`
rfcs	Rfcs	List of strings	optional	`[]`

al_rfc_repo

Mon, 01 Jan 0001 00:00:00 +0000

al_rfc_repo

load("@com_alwaldend_src//tools/rfc/main/bzl:al_rfc_repo.bzl", "al_rfc_repo")

al_rfc_repo(name, integrity, repo_mapping, rfcs, url)

Rfc repository

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this repository.	Name	required
integrity	Rfc integrity	Dictionary: String -> String	optional	`{}`
repo_mapping	In `WORKSPACE` context only: a dictionary from local repository name to global repository name. This allows controls over workspace dependency resolution for dependencies of this repository. For example, an entry `"@foo": "@bar"` declares that, for any time this repository depends on `@foo` (such as a dependency on `@foo//some:target`, it should actually resolve that dependency within globally-declared `@bar` (`@bar//some:target`). This attribute is not supported in `MODULE.bazel` context (when invoking a repository rule inside a module extension’s implementation function).	Dictionary: String -> String	optional
rfcs	Rfcs	List of strings	optional	`[]`
url	Url format	String	optional	`"https://www.rfc-editor.org/rfc/{postfix}"`

al_run_tool

Mon, 01 Jan 0001 00:00:00 +0000

al_run_tool

load("@com_alwaldend_src//tools/run_tool/main/bzl:al_run_tool.bzl", "al_run_tool")

al_run_tool(name, tool, executable, test, **kwargs)

Generate either native_test, native_binary, or run_binary target

PARAMETERS

Name	Description	Default Value
name	Target name (required)	none
tool	Tool label to run (required)	none
executable	If True, generate native_binary	`False`
test	If True, generate native_test	`False`
kwargs	kwargs for rules	none

al_sh_library

Mon, 01 Jan 0001 00:00:00 +0000

al_sh_library

load("@com_alwaldend_src//tools/sh/main/bzl:al_sh_library.bzl", "al_sh_library")

al_sh_library(name, shfmt_src, editorconfig_src, shellcheck_src, run_args_src, visibility,
              test_data, **sh_kwargs)

Create targets for a shell library

Targets:

${name}.shfmt_fix: executable to run shfmt
${name}.shfmt_test: test whether the script is formatted
${name}.shellcheck_test: shellcheck test

PARAMETERS

Name Description Default Value

name target name none

shfmt_src

"//tools/shfmt"

editorconfig_src

"//tools/shfmt:editorconfig"

shellcheck_src

"//tools/shellcheck"

run_args_src

"//tools/sh/main/sh:run_args_lib"

visibility

["//:__subpackages__"]

test_data

al_toml_data

Mon, 01 Jan 0001 00:00:00 +0000

al_toml_data

load("@com_alwaldend_src//tools/toml/main/bzl:al_toml_data.bzl", "al_toml_data")

al_toml_data(name, deps, srcs, tomlv)

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this target.	Name	required
deps	Toml data targets	List of labels	optional	`[]`
srcs	Toml files	List of labels	optional	`[]`
tomlv	Tomlv target to use for validation	Label	optional	`"@com_alwaldend_src//tools/tomlv"`

al_toml_info

Mon, 01 Jan 0001 00:00:00 +0000

AlTomlInfo

load("@com_alwaldend_src//tools/toml/main/bzl:al_toml_info.bzl", "AlTomlInfo")

AlTomlInfo(srcs, deps)

Provide toml data info

FIELDS

Name	Description
srcs	Toml files
deps	Toml data targets

al_toml_validate

Mon, 01 Jan 0001 00:00:00 +0000

al_toml_validate

load("@com_alwaldend_src//tools/toml/main/bzl:al_toml_validate.bzl", "al_toml_validate")

al_toml_validate()

Aspect adding linters for toml files

ASPECT ATTRIBUTES

Name	Type
deps	String

ATTRIBUTES

al_toolchain

Mon, 01 Jan 0001 00:00:00 +0000

al_toolchain

load("@com_alwaldend_src//projects/al/rules/al:al_toolchain.bzl", "al_toolchain")

al_toolchain(name, al)

Al toolchain

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this target.	Name	required
al	Al binary	Label	required

al_toolchain_resolved

Mon, 01 Jan 0001 00:00:00 +0000

al_toolchain_resolved

load("@com_alwaldend_src//projects/al/rules/al:al_toolchain_resolved.bzl", "al_toolchain_resolved")

al_toolchain_resolved(name)

Resolved al toolchain (for genrules)

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this target.	Name	required

al_transitive_sources

Mon, 01 Jan 0001 00:00:00 +0000

AlTransitiveSources

load("@com_alwaldend_src//tools/transitive_sources/main/bzl:al_transitive_sources.bzl", "AlTransitiveSources")

AlTransitiveSources(transitive_sources)

Provide transitive sources

FIELDS

Name	Description
transitive_sources	-

al_transitive_sources

load("@com_alwaldend_src//tools/transitive_sources/main/bzl:al_transitive_sources.bzl", "al_transitive_sources")

al_transitive_sources(srcs, deps)

Obtain the source files for a target and its transitive dependencies.

PARAMETERS

Name	Description	Default Value
srcs	a list of source files	none
deps	a list of targets that are direct dependencies	none

RETURNS

a collection of the transitive sources

al_txt_data

Mon, 01 Jan 0001 00:00:00 +0000

al_txt_data

load("@com_alwaldend_src//tools/txt/main/bzl:al_txt_data.bzl", "al_txt_data")

al_txt_data(name, srcs, **kwargs)

Text data

PARAMETERS

Name	Description	Default Value
name	target name	none
srcs	sources	none
kwargs	filegroup kwargs	none

al_unpack_archives

Mon, 01 Jan 0001 00:00:00 +0000

al_unpack_archives

load("@com_alwaldend_src//tools/pkg/main/bzl:al_unpack_archives.bzl", "al_unpack_archives")

al_unpack_archives(name, srcs, out)

Unpack several archives using tar into a directory

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this target.	Name	required
srcs	-	List of labels	required
out	-	String	optional	`""`

al_vial_configs

Mon, 01 Jan 0001 00:00:00 +0000

al_vial_configs

load("@com_alwaldend_src//tools/vial/main/bzl:al_vial_configs.bzl", "al_vial_configs")

al_vial_configs(name, srcs, visibility, **kwargs)

Generate vial config targets

PARAMETERS

Name	Description	Default Value
name	generated docs archive name	none
srcs	vial config	none
visibility	visibility	`None`
kwargs	kwargs for template_files	none

al_write_script

Mon, 01 Jan 0001 00:00:00 +0000

al_write_script

load("@com_alwaldend_src//tools/sh/main/bzl:al_write_script.bzl", "al_write_script")

al_write_script(name, out, content, make_vars, set_flags, shebang)

Write a script and make it executable

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this target.	Name	required
out	Output file	Label; nonconfigurable	required
content	Script content	String	required
make_vars	Additional make vars	Dictionary: String -> String	optional	`{}`
set_flags	Flags to pass to set	List of strings	optional	`["-eu"]`
shebang	Sheband to use	String	optional	`"#!/usr/bin/env sh"`