Semantic release #163
Draft
Semantic release #163
Conversation
This file contains 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
greenkiwi
force-pushed
the
semantic-release
branch
from
b50ce01
to
ea35012
Compare
This adds pre-commit and ci checks to ensure that commit messages follow [`conventional-commits`](https://www.conventionalcommits.org/en/v1.0.0/). From their site: Conventional Commits is: `A specification for adding human and machine readable meaning to commit messages` Commit messages must follow the following format: ``` <type>[optional scope]: <description> [optional body] [optional footer(s)] ``` In general, this means that you will provide a topic: * feat * fix * ci * refactor Followed by a description. Following this standard allows for automatic semantic versioning and release note generation. * `.commitlintrc.yaml` - defines the commit message format for linting * `.cz.json` - configuration for [`commitizen-cli`](http://commitizen.github.io/cz-cli/)
This shifts the release workflow to run after a successful CI run. It then generates a new semantic version and then runs the go-releaser on that version.
greenkiwi
force-pushed
the
semantic-release
branch
from
ea35012
to
16ef9d7
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description of the change
This shifts to using semantic release for your GitHub release generation.
One requirement is that the comment messages follow conventional-commits formatting.
We tend to remove all "merge" options in our repos - we only allow
rebase merges- which results in linear historyOnce in place - this tooling will automatically generate new semantic versions as well as release notes.
You can see an examples of this here: https://github.com/turo/pre-commit-hooks/releases
You can see where it has called out a breaking change that requires the major version to be incremented:
One potential shift you could make would be to split the release action into two pieces:
Type of change
Checklists
Development
Code review
Testing
You will need to test and confirm that the workflow works as you expect it to work. I do not plan on creating any "test releases" :)