Skip to content
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

Add release please action #71

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Conversation

sgerloff
Copy link
Contributor

@sgerloff sgerloff commented Mar 21, 2024

Description

Automate the release creation for db-rocket. This ensures that

  • the version is bumped
  • changelogs are updated
  • a version tag is created
  • a release is drafted
  • the code is published to pypi upon new release

The mechanism: PR's should be merged via a specific format of the commit message, which instructs the release-please action how to increase the version. Then a release can be triggered by merging the PR opened by the release-please action. To help users with having the right format for the commit message, we should set the default commit message for merging PR to be the title and ensure during the review that the title is in the correct format. The correct format is:

  • feat: description ... (for a minor version bump)
  • fix: description ... (for a patch version bump)
  • feat!: description (or anything else with !) (for a major version bump)

Added tests?

  • 👍 yes
  • 🙅 no, because they aren't needed

Added to documentation?

  • 👍 README.md
  • 👍 CHANGELOG.md
  • 👍 Additional documentation in /docs
  • 👍 Relevant code documentation
  • 🙅 no, because they aren’t needed

@sgerloff sgerloff requested a review from a team as a code owner March 21, 2024 11:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant