Releases are cut from main by the release workflow. Start one with:
./scripts/release.sh v1.2.3This triggers .github/workflows/release.yml on main, which:
- checks that the tag is the next patch, minor, or major version;
- runs CI for the tag, which builds and tests each OS on its own runner and packages the release archives and SBOMs (see CONTRIBUTING.md);
- attests the provenance of these archives and publishes them as a GitHub release of
the
maincommit with./scripts/publish.sh, which also creates the tag; - opens a pull request that updates the Homebrew formula and merges once approved.
Tags are protected, so they are only created by the workflow, with a
dd-octo-sts token scoped by .github/chainguard/self.release.sts.yaml.
Release assets, for darwin/amd64, darwin/arm64, linux/amd64, linux/arm64, windows/amd64, and windows/arm64:
bits_<version>_<os>_<arch>.tar.gz macOS/Linux install prefix
bits_<version>_windows_<arch>.zip Windows install prefix
bits_<version>_<os>_<arch>.tar.gz.sbom.json SPDX JSON SBOM of a macOS/Linux archive
bits_<version>_windows_<arch>.zip.sbom.json SPDX JSON SBOM of a Windows archive
bits_<version>_checksums.txt SHA-256 of every archive and SBOM
Each archive is an install prefix, which Homebrew installs as is:
bin/bits bits.exe on Windows
libexec/bits/<tool>/ libexec helpers built for the platform, if any
share/doc/bits/ README.md, LICENSE, LICENSE-3rdparty.csv
Verify a download with:
sha256sum --check --ignore-missing bits_<version>_checksums.txt
gh attestation verify bits_<version>_<os>_<arch>.tar.gz \
--repo datadog-labs/bits-cli \
--signer-workflow datadog-labs/bits-cli/.github/workflows/release.yml \
--source-ref refs/heads/mainFor Windows, verify bits_<version>_windows_<arch>.zip with the same
attestation command.
Build archives and checksums locally in dist/ with either:
./scripts/dist.sh v1.2.3 # build every platform, then package
VERSION=1.2.3 ./scripts/build.sh linux/amd64 … # what CI runs on each OS
./scripts/package.sh v1.2.3 # every platform's prefix in build/package.sh refuses an executable that go version -m does not report as a
clean build of the current commit for its platform, so commit first.
dist.sh runs on macOS with the Xcode command line tools, which build the
macOS-only ddviz helper. Add --sbom before the
tag to include SBOMs; this requires Syft.
Release platforms are listed in scripts/platforms.sh.
The bits formula of the datadog-labs/homebrew-pack
tap is rendered from .github/homebrew/bits.rb.erb. After each release, the release
workflow's homebrew job opens the tap pull request "Update bits to v1.2.3" and
enables auto-merge, so it merges once a tap reviewer approves it. It runs
./scripts/homebrew.rb --output DIR v1.2.3 to verify the release and render the
formula, then commits it as a signed API commit with a dd-octo-sts token scoped by
the tap's .github/chainguard/bits-cli.release.sts.yaml. Re-running the job
updates the same branch and pull request.
To propose a release by hand, for example when the job failed, run:
./scripts/homebrew.rb v1.2.3The script verifies the release archives against the release checksums and
their build provenance attestations, commits the formula to a branch of the tap
(or of your fork of it), and opens a draft pull request. --dry-run verifies the
release and previews the formula diff, push destination, and PR title and body.
It does not commit, create a fork, push, or create or update a PR.
It needs Ruby and an authenticated gh.
Commits use your git signing configuration.