ci: automate library release with Release and Promote workflows#77
Open
g-carre wants to merge 2 commits into
Open
ci: automate library release with Release and Promote workflows#77g-carre wants to merge 2 commits into
g-carre wants to merge 2 commits into
Conversation
Automate the library release flow, adapting the pattern from scality/nodeip-discovery#2 for a pure Go library (no container/binary artifact): - release.yaml: manual dispatch to compute the next semver (alpha/beta/GA x patch/minor/major) and push an annotated v* tag. - promote.yaml: on a v* tag push, create a GitHub Release with generated notes, marking prereleases when the tag has a hyphen. The reference build.yaml/post-merge.yaml and the promote build job are omitted since a library ships as a git tag consumed via `go get`, not a Docker image. Issue: ARTESCA-17773
![claude[bot]](https://avatars.githubusercontent.com/in/1236702?s=60&v=4){kind=small}
Contributor
|
Compute the base tag with `git tag --merged HEAD --sort=version:refname` instead of `--sort=taggerdate`: - version:refname orders by semantic version, so an older-line hotfix tagged after a newer release no longer becomes the base. - --merged HEAD scopes selection to the current branch's history, making it correct for future per-minor release branches (e.g. releasing v1.0.x from dev/1.0 while v2.0.0 lives on main). grep -v '-' is retained: version sort would otherwise rank a prerelease above its GA. Issue: ARTESCA-17773
| # NOTE: when release branches are added, also relax the `main`-only guard | ||
| # above and constrain non-`main` branches to patch-scope releases. | ||
| run: | | ||
| last_ga_tag=$(git tag --merged HEAD --sort=version:refname --list "v*" | grep -v '\-' | tail -n 1) |
Contributor
There was a problem hiding this comment.
grep -v '\-' returns exit code 1 when no lines match. With GitHub Actions' default set -e -o pipefail, this kills the pipeline before the fallback on line 58 (last_ga_tag="0.0.0") can fire. This breaks the first-ever release and any release when only pre-release tags exist.
Suggested change
| last_ga_tag=$(git tag --merged HEAD --sort=version:refname --list "v*" | grep -v '\-' | tail -n 1) | |
| last_ga_tag=$(git tag --merged HEAD --sort=version:refname --list "v*" | { grep -v '\-' || true; } | tail -n 1) |
— Claude Code
| - "v*" | ||
|
|
||
| jobs: | ||
| create-release: |
Contributor
There was a problem hiding this comment.
No permissions block is declared. If the repo (or org) restricts the default GITHUB_TOKEN to read-only (GitHub's recommended default), softprops/action-gh-release will fail with a 403 because it needs write access to create releases.
Suggested change
| create-release: | |
| permissions: | |
| contents: write | |
| runs-on: ubuntu-24.04 |
— Claude Code
Contributor
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds two GitHub Actions workflows to automate the release flow for this Go library, adapting the pattern from scality/nodeip-discovery#2:
release.yaml— manualworkflow_dispatchfrommain. Computes the next semver (alpha/beta/GA×patch/minor/major) off the last GA tag and pushes an annotatedv*tag.promote.yaml— triggers on av*tag push and creates a GitHub Release with generated notes, marking prereleases when the tag contains a hyphen.Flow: click Release → tag is created → Promote fires → GitHub Release published.
Why it differs from the reference
nodeip-discovery is a deployable service (builds a Docker image). raidmgmt is a pure library — no
Dockerfile, nocmd/, consumed viago get ...@vX.Y.Z, so the git tag is the artifact. The referencebuild.yaml/post-merge.yamland the promotebuildjob are therefore omitted.generate-sbomwas intentionally left out: it targets a Docker image and uploads to Dependency Track, which is redundant for a library whose deps are already captured in the consuming component's SBOM.Prerequisite
release.yamlusesvars.ACTIONS_APP_ID+secrets.ACTIONS_APP_PRIVATE_KEY(already configured in this repo — referenced byreview.yml).Issue: ARTESCA-17773
🤖 Generated with Claude Code