-
Notifications
You must be signed in to change notification settings - Fork 6
feat: automatic release process #120
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
- Add GitHub Actions workflow for automated releases - Update bumpversion configuration - Support patch/minor/major semantic versioning
|
@liammcalpineduckietown there is a bug in the workflow file causing the release to file. Also the workflow is missing publishing to PyPi, please add it according to the Makefile (or using the PyPi/twine publishing action) |
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 introduces automated semantic versioning and release management to the repository, eliminating the need for manual version tagging and release creation. The automation handles version bumps, changelog generation, and GitHub releases through a GitHub Actions workflow.
Key changes:
- Added GitHub Actions workflow for automated releases with configurable version bump types (patch/minor/major)
- Updated bumpversion configuration to use proper tag naming and commit messages
- Enhanced README documentation with release workflow instructions
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
.github/workflows/release.yml |
New workflow automating version bumps, tagging, changelog generation, and GitHub releases |
.bumpversion.cfg |
Updated configuration to use v-prefixed tags and descriptive commit messages |
README.md |
Added documentation for the automated release process and workflow usage |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
|
@liammcalpineduckietown LGTM but tests are failing |
This is your PR. Please create a Jira issue for it and update the title. |
This pull request introduces automated semantic versioning and release management to the repository. The main changes include adding a GitHub Actions workflow for automated releases, updating the versioning configuration, and documenting the new release process in the
README.md.Automated Release Workflow:
.github/workflows/release.ymlto automate version bumps, tagging, changelog generation, and GitHub releases. The workflow supports patch, minor, and major version increments, and can optionally mark releases as pre-releases.Versioning Configuration:
.bumpversion.cfgto include custom tag names and commit messages for releases, ensuring tags are prefixed withvand commit messages reflect the version change.Documentation Updates:
README.mddescribing the automated release workflow, how to use it, and what it does. It also links to more detailed release process documentation.