@@ -50,21 +50,24 @@ Apply appropriate labels to PRs before merging. Labels determine the version bum
5050| ` changes/minor ` , ` type/feature ` , ` type/refactoring ` | Minor (1.0.0 → 1.1.0) | New features, refactoring |
5151| ` changes/patch ` , ` type/bug ` , ` type/housekeeping ` , ` type/documentation ` | Patch (1.0.0 → 1.0.1) | Bug fixes, docs, maintenance |
5252
53- PRs are auto-labeled based on title patterns:
53+ Auto-labeling rules are configured in ` .github/release-drafter.yml ` but require a separate
54+ workflow trigger to activate. For now, apply labels manually:
5455
55- - Title contains ` fix ` → ` type/bug `
56- - Title contains ` enhance ` , ` improve ` , or ` feature ` → ` type/feature `
57- - Title contains ` chore ` → ` ci/skip-changelog ` (excluded from release notes)
56+ | PR Title Pattern | Recommended Label |
57+ | ---------------------------------------- | ------------------- |
58+ | Contains ` fix ` | ` type/bug ` |
59+ | Contains ` enhance ` , ` improve ` , ` feature ` | ` type/feature ` |
60+ | Contains ` chore ` | ` ci/skip-changelog ` |
61+ | Contains ` deprecat ` | ` type/deprecated ` |
5862
5963#### Step 2: Merge to Main
6064
6165Merge your labeled PR to the ` main ` branch. The automation will:
6266
63671 . Calculate the next version based on PR labels
64- 2 . Update ` pyproject.toml ` with the new version
65- 3 . Update ` poetry.lock `
66- 4 . Commit changes as ` chore(release): v{VERSION} [skip ci] `
67- 5 . Create/update a draft GitHub Release with auto-generated release notes
68+ 2 . Update ` pyproject.toml ` with the new version (and regenerate ` poetry.lock ` )
69+ 3 . Commit changes as ` chore(release): v{VERSION} [skip ci] `
70+ 4 . Create/update a draft GitHub Release with auto-generated release notes
6871
6972#### Step 3: Publish the GitHub Release
7073
@@ -187,9 +190,9 @@ Ensure PRs have appropriate labels before merging. If labels are missing, the ve
187190
188191### Workflow Files Reference
189192
190- | Workflow | Trigger | Purpose |
191- | ------------------------------ | --------------------------- | ------------------------------------------------------------------ |
192- | ` trigger-push-stable.yml ` | Push to ` main ` /` stable ` | Calculates version, bumps ` pyproject.toml ` , triggers release draft |
193- | ` workflow-release-drafter.yml ` | Called by push workflow | Creates/updates GitHub Release draft with notes |
194- | ` trigger-release.yml ` | GitHub Release published | Triggers PyPI publish |
195- | ` workflow-publish.yml ` | Release published or manual | Builds and publishes package to PyPI |
193+ | Workflow | Type | Purpose |
194+ | ------------------------------ | ------------------------------ | ------ ------------------------------------------------------------------ |
195+ | ` trigger-push-stable.yml ` | Push to ` main ` /` stable ` | Calculates version, bumps ` pyproject.toml ` , triggers release draft |
196+ | ` workflow-release-drafter.yml ` | Reusable ( ` workflow_call ` ) | Creates/updates GitHub Release draft; invoked by ` trigger-release.yml ` |
197+ | ` trigger-release.yml ` | GitHub Release published | Orchestrates release: invokes release drafter and publish workflows |
198+ | ` workflow-publish.yml ` | Reusable ( ` workflow_dispatch ` ) | Builds and publishes package to PyPI; invoked by ` trigger-release.yml ` |
0 commit comments