Skip to content

feat: Automate release‑candidate version bump & release‑note guard #9276

Open
@Amnah199

Description

@Amnah199

Background
Updating the VERSION.txt file from one release‑candidate tag (e.g. 2.3.0‑rc0) to the next (2.3.0‑rc1) is still a manual step. Likewise, the check of at least one new release note between the two tags is needs to be performed manually. if it’s forgotten, the github_release workflow fails later with a Reno KeyError.

Proposal
Create a GitHub Actions workflow that:

  • Reads the current version in VERSION.txt on the release branch (e.g. v2.3.x).
  • Computes the next ‑rc version (increment the trailing rc integer).
  • (If possible )Verifies that there is a release note between two rc tags.
  • Updates VERSION.txt, commits the change on the same branch, and pushes it back to GitHub (see below).
    git add . && git commit -m "bump version to 2.3.0-rc1" && git push origin v2.3.x

Criteria

  • A new workflow file at .github/workflows/bump-rc-version.yml.
  • Triggered manually via workflow_dispatch, with an optional input to override the computed next‑rc value.
  • Uses the GitHub token to open a commit on the current release branch (vX.Y.x).
  • If Reno finds no release notes between tags, the job fails with a clear error message.
  • On success, the workflow commits bump version to <next‑rc> and pushes it.
  • Documentation (Notion) is updated to describe the automated bump & note‑check.

Metadata

Metadata

Assignees

No one assigned

    Labels

    P2Medium priority, add to the next sprint if no P1 available

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions