-
Notifications
You must be signed in to change notification settings - Fork 0
Document the release process #33
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.
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
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| # Release Process | ||
|
|
||
| Releases are fully automated via GitHub Actions. Pushing a version tag is the only manual step required. | ||
|
|
||
| ## Versioning | ||
|
|
||
| This project uses [Semantic Versioning](https://semver.org/). | ||
| Versions are derived automatically from git tags via `hatch-vcs` — there is no version field to update manually. | ||
|
|
||
| Tag format: `vX.Y.Z` (e.g. `v1.2.0`) | ||
|
|
||
| ## Releasing a new version | ||
|
|
||
| ```bash | ||
| git tag vX.Y.Z | ||
| git push origin vX.Y.Z | ||
| ``` | ||
|
|
||
| That's it. The CI pipeline takes over from here. | ||
|
|
||
| ## What CI does | ||
|
|
||
| Pushing a tag triggers the release workflow (`.github/workflows/release.yml`), which runs the following in order: | ||
|
|
||
| `git tag` → CI Pipeline → Build Artifacts → Publish to All Channels | ||
|
|
||
| ### PyPI | ||
|
mowi12 marked this conversation as resolved.
|
||
|
|
||
| Builds a wheel and sdist via `uv build`, publishes via `uv publish` using OIDC trusted publishing (no token required). | ||
|
|
||
| ## Required secrets | ||
|
|
||
| | Secret | Used for | Where to configure | | ||
| |-----------------|--------------|---------------------------------| | ||
| | *(none — OIDC)* | PyPI publish | PyPI trusted publisher settings | | ||
|
|
||
| ## Verifying a release | ||
|
|
||
| After the workflow completes, confirm the new version is available on each channel: | ||
|
mowi12 marked this conversation as resolved.
|
||
|
|
||
| ### PyPI | ||
|
|
||
| ```bash | ||
| pipx install mr-manager==X.Y.Z | ||
| ``` | ||
|
|
||
| ## Troubleshooting | ||
|
|
||
| ### PyPI Publish Failed | ||
|
|
||
| Check the Actions log for OIDC errors. Confirm the trusted publisher is configured correctly on pypi.org | ||
| (owner, repo, workflow filename, and environment name must all match exactly). | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.