relacs automates the ACS release process.
It starts as a collection of utility commands, implemented in Go.
Use them to interact with GitHub, Konflux & co.
A minimum required version can be enforced in case of incompatible changes by bumping MINIMUM_REQUIRED_VERSION.
relacs requires network access to GitHub and GH_TOKEN variable set on every command execution by design to verify the minimum required version.
- Completed Membership and access section from the release instructions.
- Need to be logged in to our Konflux tenant with Maintainer role, for example with
oc login --web https://api.stone-prd-rh01.pg1f.p1.openshiftapps.com:6443/.
You need an authenticated gh CLI for this.
Without cloning this repository:
bash <(gh api -H "Accept: application/vnd.github.v3.raw" "/repos/stackrox/relacs/contents/scripts/install-relacs.sh") [version]or in a clone of this repository:
./scripts/install-relacs.sh [version][version] is an optional argument to select a specific released version.
If not specified, the latest relacs version will be installed.
- Go to the Releases page.
- Select and download the appropriate binary for your OS and architecture.
- Move it to your PATH.
- Confirm it's working with
relacs version.
git clone git@github.com:stackrox/relacs.git
cd relacs
go install -ldflags "-X 'github.com/stackrox/relacs/cmd/relacs/version.version=$(make version)'" ./cmd/relacsThis places the relacs binary into your $GOPATH/bin. Make sure that directory is in your PATH.
GH_TOKEN: A personal GitHub token. Run:export GH_TOKEN=$(gh auth token)
JIRA_EMAIL. An email from Jira account. Run:export JIRA_EMAIL="<YOUR_EMAIL>"
JIRA_TOKEN. A personal API Jira token. Can be created on the API tokens page. Run:export JIRA_TOKEN="<YOUR_JIRA_API_TOKEN>"
- Other configuration values are hard-coded in
pkg/config/config.go.
See COMMANDS.md.
Commands in relacs interact with resources in the Konflux cluster through the KubeArchive REST API.
The read-only commands query historical data via KubeArchive using direct HTTP requests. Authentication is handled via the bearer token from your kubeconfig (oc login).
When introducing breaking configuration changes or fixing critical bugs that require users to update to the fixed version, release and update the MINIMUM_REQUIRED_VERSION to the next expected version.
- Merge your PR.
- Switch to
mainbranch.git checkout main; git pull --ff-only origin main; git fetch --tags --force - Find the most recent
vN.M.Ktag on it. Come up with the following tag numbervX.Y.Z. - Tag the HEAD commit with
git tag -m "vX.Y.Z" vX.Y.Zand push the tag. - CI will build and publish a release with downloadable binaries. Check that it's there on the Releases page.
- Open a PR bumping
MINIMUM_REQUIRED_VERSIONtovX.Y.Zand get it merged.