Skip to content

Add workflow for rolling back release #3033

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mbg merged 19 commits into from
Sep 1, 2025
+408 −79
Merged

Add workflow for rolling back release #3033

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
bd8a3ce
Refactor `prepare` job into a reusable workflow
mbg Aug 14, 2025
049a0a7
Add initial `rollback-release` workflow
mbg Aug 14, 2025
a1212db
Fix `uses` paths
mbg Aug 14, 2025
541b8e4
Improve comment
mbg Aug 15, 2025
41dab09
Refactor mergeback branch prep into an action
mbg Aug 15, 2025
c700209
Add script for creating a rollback changelog
mbg Aug 15, 2025
c9665e6
Add `dry-run` input to `prepare-mergeback-branch`
mbg Aug 15, 2025
4205856
Create mergeback branch/PR
mbg Aug 15, 2025
e1654f1
Fix `prepare_changelog.py` not using `changelog_file` consistently
mbg Aug 15, 2025
e22f34a
Create a new tag for test runs, to make sure we have changes from a PR
mbg Aug 15, 2025
1e21ce3
Ensure we check out the base branch, before creating the mergeback br…
mbg Aug 15, 2025
67e42fe
Use PR branch as `BASE_BRANCH` when testing, to make sure script chan…
mbg Aug 15, 2025
25c4fcc
Ensure `NEW_BRANCH` is checked out in `prepare-mergeback-branch`
mbg Aug 27, 2025
15ed54f
Move updated changelog into place before creating mergeback PR
mbg Aug 27, 2025
8f01f5d
Apply suggestions from code review
mbg Aug 29, 2025
43d629c
Use `argparse` in `rollback_changelog.py`
mbg Aug 29, 2025
b06d325
Add draft release URL to job summary
mbg Aug 29, 2025
9389ce0
Merge remote-tracking branch 'origin/main' into mbg/ci/rollback-release
mbg Aug 29, 2025
872a6a4
Add `pull-requests: write` permission
mbg Sep 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Use argparse in rollback_changelog.py
  • Loading branch information
@mbg
mbg committed Aug 29, 2025
commit 43d629cdfd9a8e4ac201aeb0d9330b2eaf0f8699
5 changes: 4 additions & 1 deletion .github/workflows/rollback-release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,10 @@ jobs:
LATEST_TAG: ${{ needs.prepare.outputs.latest_tag }}
VERSION: "${{ needs.prepare.outputs.version }}"
run: |
python .github/workflows/script/rollback_changelog.py "${ROLLBACK_TAG:1}" "${LATEST_TAG:1}" "$VERSION" > $NEW_CHANGELOG
python .github/workflows/script/rollback_changelog.py \
--target-version "${ROLLBACK_TAG:1}" \
--rollback-version "${LATEST_TAG:1}" \
--new-version "$VERSION" > $NEW_CHANGELOG

echo "::group::New CHANGELOG"
cat $NEW_CHANGELOG
Expand Down
18 changes: 9 additions & 9 deletions .github/workflows/script/rollback_changelog.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import datetime
import os
import sys
import argparse

EMPTY_CHANGELOG = """# CodeQL Action Changelog

Expand Down Expand Up @@ -52,11 +52,11 @@ def update_changelog(target_version, rollback_version, new_version):
# - rollback_version: the version that we are rolling back, typically the one that followed `target_version`
# - new_version: the new version that we are releasing `target_version` as, typically the one that follows `rollback_version`
#
# Example: python3 .github/workflows/script/rollback_changelog.py "1.2.3" "1.2.4" "1.2.5"
if len(sys.argv) < 4:
raise Exception('Expecting argument: target_version rollback_version new_version')

target_version = sys.argv[1]
rollback_version = sys.argv[2]
new_version = sys.argv[3]
update_changelog(target_version, rollback_version, new_version)
# Example: python3 .github/workflows/script/rollback_changelog.py --target-version "1.2.3" --rollback-version "1.2.4" --new-version "1.2.5"
parser = argparse.ArgumentParser(description="Update CHANGELOG.md for a rollback release.")
parser.add_argument("--target-version", "-t", required=True, help="Version to re-release as new_version.")
parser.add_argument("--rollback-version", "-r", required=True, help="Version being rolled back.")
parser.add_argument("--new-version", "-n", required=True, help="New version to publish for target_version.")
args = parser.parse_args()

update_changelog(args.target_version, args.rollback_version, args.new_version)