-
Notifications
You must be signed in to change notification settings - Fork 25
feat: add release-please configuration and version manifest #105
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
Conversation
|
Caution Review failedThe pull request is closed. 📝 WalkthroughWalkthroughThis PR introduces automated release management using release-please. A new GitHub Actions workflow job is added to detect version changes on the main branch. The publish job is restructured to depend on the release-please job and trigger only when a release is created, including steps to build and publish the package to PyPI. Changes
Sequence DiagramsequenceDiagram
actor Developer
participant GitHub as GitHub Actions
participant ReleasePlease as Release Please Action
participant Builder as Build System (uv)
participant PyPI as PyPI Registry
Developer->>GitHub: Push commit to main
GitHub->>ReleasePlease: Trigger release-please job
ReleasePlease->>ReleasePlease: Detect version change<br/>in _version.py
alt Version changed
ReleasePlease->>GitHub: Output release_created=true
GitHub->>Builder: Start publish job
Builder->>Builder: Checkout code
Builder->>Builder: Build package
Builder->>PyPI: Publish package
PyPI-->>Builder: Confirm publication
else No version change
ReleasePlease->>GitHub: Output release_created=false
GitHub-->>Developer: Skip publish
end
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Poem
✨ Finishing touches
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Codecov Report✅ All modified and coverable lines are covered by tests.
🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR adds release-please automation to manage version bumps and releases. It introduces configuration files for release-please and modifies the GitHub Actions workflow to trigger automated releases on pushes to main, replacing the previous tag-based release mechanism.
Changes:
- Added release-please configuration files (release-please-config.json and .release-please-manifest.json)
- Added x-release-please-version marker to _version.py
- Introduced release-please job in the workflow that runs after all tests pass
- Changed publish job to trigger on release creation instead of on tags
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| release-please-config.json | Configures release-please for Python package with extra version file tracking |
| .release-please-manifest.json | Tracks current version (1.2.0) for release-please |
| src/fishaudio/_version.py | Adds marker comment for release-please to update version |
| .github/workflows/python.yml | Adds release-please job and updates publish job to use release-please output |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Summary by CodeRabbit