Skip to content

Commit b477e44

Browse files
committed
feat(release): enhance workflow dispatch with release type options and improve documentation
1 parent 6bd891e commit b477e44

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

.github/workflows/release.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ jobs:
3232
echo "ref=${GITHUB_REF}"
3333
echo "actor=${GITHUB_ACTOR}"
3434
echo "default_branch=${{ github.event.repository.default_branch }}"
35+
echo "release_type=${{ github.event.inputs.release_type || 'auto' }}"
3536
3637
- uses: actions/checkout@v4
3738
with:

CONTRIBUTING.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -110,10 +110,11 @@ Use this rule of thumb for automatic versioning:
110110
How to trigger semantic release until publish to PyPI:
111111

112112
1. Push commits to default branch (direct push or merged PR), using Conventional Commit messages.
113-
2. Open GitHub Actions and run `Semantic Release` on default branch.
114-
3. Workflow evaluates commits and creates tag `vX.Y.Z` when releasable commits exist.
115-
4. Workflow creates the corresponding GitHub Release.
116-
5. CI workflow runs on that tag and publishes artifacts to PyPI.
113+
2. Open GitHub Actions and run `Semantic Release` on the default branch.
114+
3. Choose `release_type`: `auto` (default) for commit-based bump, or `patch`/`minor`/`major` to force bump manually.
115+
4. Workflow evaluates commits and creates tag `vX.Y.Z` when releasable commits exist.
116+
5. Workflow creates the corresponding GitHub Release.
117+
6. CI workflow runs on that tag and publishes artifacts to PyPI.
117118

118119
Manual fallback (if needed):
119120

0 commit comments

Comments
 (0)