Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 2 additions & 1 deletion .github/workflows/release-please.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@ jobs:
id: release
if: ${{ github.event_name != 'workflow_dispatch' || inputs.publish != true }}
with:
release-type: python
config-file: release-please-config.json
manifest-file: .release-please-manifest.json

- name: Checkout release PR
if: ${{ steps.release.outputs.prs_created == 'true' }}
Expand Down
3 changes: 3 additions & 0 deletions PYPI_SETUP.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,9 @@ Versions are managed automatically by Release Please:
- `feat:` commits → minor version bump (0.1.0 → 0.2.0)
- `fix:` commits → patch version bump (0.1.0 → 0.1.1)
- `feat!:` or `BREAKING CHANGE:` → major bump (pre-1.0: minor)
- During a beta line (`X.Y.Z-beta.N`), releasable commits increment the beta
counter only (`X.Y.Z-beta.N+1`) because the workflow uses manifest-mode
Release Please config.

## Verification

Expand Down
14 changes: 14 additions & 0 deletions RELEASING.md
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,20 @@ We follow [Semantic Versioning](https://semver.org/):
- **Minor (0.1.0)**: New features, backward compatible
- **Patch (0.0.1)**: Bug fixes, backward compatible

### Beta Release Behavior

While the current manifest version is a beta (`X.Y.Z-beta.N`), Release Please
is configured to keep the base version fixed and increment only the beta
counter. For example:

- `feat:` after `6.3.0-beta.4` -> `6.3.0-beta.5`
- `fix:` after `6.3.0-beta.4` -> `6.3.0-beta.5`

Do not pass `release-type` directly in `.github/workflows/release-please.yml`;
that bypasses the manifest configuration. The workflow must use
`release-please-config.json` and `.release-please-manifest.json` so
`versioning: prerelease` takes effect.

### Pre-1.0 Behavior

Before v1.0.0:
Expand Down
Loading