Skip to content

Commit 43d629c

Browse files
committed
Use argparse in rollback_changelog.py
1 parent 8f01f5d commit 43d629c

File tree

2 files changed

+13
-10
lines changed

2 files changed

+13
-10
lines changed

.github/workflows/rollback-release.yml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,10 @@ jobs:
8585
LATEST_TAG: ${{ needs.prepare.outputs.latest_tag }}
8686
VERSION: "${{ needs.prepare.outputs.version }}"
8787
run: |
88-
python .github/workflows/script/rollback_changelog.py "${ROLLBACK_TAG:1}" "${LATEST_TAG:1}" "$VERSION" > $NEW_CHANGELOG
88+
python .github/workflows/script/rollback_changelog.py \
89+
--target-version "${ROLLBACK_TAG:1}" \
90+
--rollback-version "${LATEST_TAG:1}" \
91+
--new-version "$VERSION" > $NEW_CHANGELOG
8992
9093
echo "::group::New CHANGELOG"
9194
cat $NEW_CHANGELOG

.github/workflows/script/rollback_changelog.py

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import datetime
22
import os
3-
import sys
3+
import argparse
44

55
EMPTY_CHANGELOG = """# CodeQL Action Changelog
66
@@ -52,11 +52,11 @@ def update_changelog(target_version, rollback_version, new_version):
5252
# - rollback_version: the version that we are rolling back, typically the one that followed `target_version`
5353
# - new_version: the new version that we are releasing `target_version` as, typically the one that follows `rollback_version`
5454
#
55-
# Example: python3 .github/workflows/script/rollback_changelog.py "1.2.3" "1.2.4" "1.2.5"
56-
if len(sys.argv) < 4:
57-
raise Exception('Expecting argument: target_version rollback_version new_version')
58-
59-
target_version = sys.argv[1]
60-
rollback_version = sys.argv[2]
61-
new_version = sys.argv[3]
62-
update_changelog(target_version, rollback_version, new_version)
55+
# Example: python3 .github/workflows/script/rollback_changelog.py --target-version "1.2.3" --rollback-version "1.2.4" --new-version "1.2.5"
56+
parser = argparse.ArgumentParser(description="Update CHANGELOG.md for a rollback release.")
57+
parser.add_argument("--target-version", "-t", required=True, help="Version to re-release as new_version.")
58+
parser.add_argument("--rollback-version", "-r", required=True, help="Version being rolled back.")
59+
parser.add_argument("--new-version", "-n", required=True, help="New version to publish for target_version.")
60+
args = parser.parse_args()
61+
62+
update_changelog(args.target_version, args.rollback_version, args.new_version)

0 commit comments

Comments
 (0)