Skip to content

fix: Split release process to sync pyproject.toml version with git tags #1732

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
mnriem merged 6 commits into from
Mar 2, 2026
Merged

fix: Split release process to sync pyproject.toml version with git tags #1732

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
b1423aa
fix: split release process to sync pyproject.toml version with git ta…
mnriem Mar 2, 2026
f16853d
Update .github/workflows/RELEASE-PROCESS.md
mnriem Mar 2, 2026
e435ab8
Update .github/workflows/scripts/simulate-release.sh
mnriem Mar 2, 2026
d2aac8d
Update .github/workflows/release.yml
mnriem Mar 2, 2026
cc2754c
Update .github/workflows/release-trigger.yml
mnriem Mar 2, 2026
88e50a1
fix: harden release-trigger against shell injection and fix stale docs
mnriem Mar 2, 2026
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
fix: harden release-trigger against shell injection and fix stale docs 
- Pass workflow_dispatch version input via env: instead of direct
  interpolation into shell script, preventing potential injection attacks
- Validate version input against strict semver regex before use
- Fix RELEASE-PROCESS.md Option 2 still referencing [Unreleased] section
  handling that no longer exists in the workflow
  • Loading branch information
@mnriem
mnriem committed Mar 2, 2026
commit 88e50a10ec1b7b725641a05ca139a669c888cb06
3 changes: 1 addition & 2 deletions .github/workflows/RELEASE-PROCESS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,8 +74,7 @@ The workflow will:
The workflow will:
- Use your specified version
- Update `pyproject.toml`
- Convert `[Unreleased]` section in CHANGELOG.md to the new version
- Add a new empty `[Unreleased]` section
- Update `CHANGELOG.md` by adding a new section for the release based on commits since the last tag
- Commit changes
- Create and push git tag
- Trigger the release workflow automatically
Comment thread
mnriem marked this conversation as resolved.
Expand Down
15 changes: 10 additions & 5 deletions .github/workflows/release-trigger.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,17 @@ jobs:

- name: Determine version
id: version
env:
INPUT_VERSION: ${{ github.event.inputs.version }}
run: |
if [[ -n "${{ github.event.inputs.version }}" ]]; then
# Manual version specified
VERSION="${{ github.event.inputs.version }}"
# Remove 'v' prefix if present
VERSION=${VERSION#v}
if [[ -n "$INPUT_VERSION" ]]; then
# Manual version specified - strip optional v prefix
VERSION="${INPUT_VERSION#v}"
# Validate strict semver format to prevent injection
if [[ ! "$VERSION" =~ ^[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
echo "Error: Invalid version format '$VERSION'. Must be X.Y.Z (e.g. 1.2.3 or v1.2.3)"
exit 1
fi
echo "version=$VERSION" >> $GITHUB_OUTPUT
echo "tag=v$VERSION" >> $GITHUB_OUTPUT
echo "Using manual version: $VERSION"
Expand Down