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

chore: set up release-please #226

Merged
merged 8 commits into from
Dec 6, 2024

Conversation

sloloris
Copy link
Member

@sloloris sloloris commented Dec 4, 2024

This action should leverage Google's release-please to scan conventional commits made since the last release, auto-update the changelog, and creating / updating a release PR as you continue to merge new commits.

When you merge the release PR, it should create a tag based on the version auto-incremented according to the conventional commits it contains that are prefixed with the following:

  • fix: which represents bug fixes, and correlates to a SemVer patch.
  • feat: which represents a new feature, and correlates to a SemVer minor.
  • feat!:, or fix!:, refactor!:, etc., which represent a breaking change (indicated by the !) and will result in a SemVer major.

If i've understood correctly, other conventional commits will not be included in the changelog (example chore:).

The tag that release-please creates when you merge a release PR will be picked up by goreleaser for release.

@ldhenry ldhenry marked this pull request as ready for review December 4, 2024 16:13
@ldhenry ldhenry requested a review from a team as a code owner December 4, 2024 16:13
@sloloris sloloris changed the title add tag-for-release.yml chore: set up release-please Dec 4, 2024
@sloloris sloloris requested a review from ldhenry December 6, 2024 11:26
.github/workflows/tag-for-release.yml Outdated Show resolved Hide resolved
@sloloris sloloris requested a review from ldhenry December 6, 2024 12:48
@sloloris sloloris merged commit d9ff529 into main Dec 6, 2024
24 checks passed
@sloloris sloloris deleted the imiller/REL-4482/add-release-please-workflow branch December 6, 2024 12:49
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.

2 participants