Bzl

Bazel bindings for the release tool

1: al_release
2: al_release_binary
3: al_release_deployment
4: al_release_deployment_info
5: al_release_deps
6: al_release_files
7: al_release_files_info
8: al_release_info

1 - al_release

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"`

2 - al_release_binary

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"`

3 - al_release_deployment

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	`""`

4 - al_release_deployment_info

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

5 - al_release_deps

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

6 - al_release_files

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"`

7 - al_release_files_info

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

8 - al_release_info

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)