release-please
release-please is a project maintained by the GoogleApi's team which automatically keeps a coherent changelog of your application as it grows as well as deploying your project with a new version tag.
Why Use release-please
- Automatically generating CHANGELOGs.
- Automatically determining a semantic version bump (based on the types of commits landed).
- Communicating the nature of changes to teammates, the public, and other stakeholders.
- Triggering build and publish processes.
- Making it easier for people to contribute to your projects, by allowing them to explore a more structured commit history.
Source: conventionalcommits.org
This project not only keeps your changelog up to date by parsing your git commit history, but ensures that updates follow a common commit message convention.
release-please abides to the Conventional Commit Messages, which allows commits to be read by human and machine in a cohesive fashion.
Conventional Commits
Source: conventionalcommits.org
This aims to create a convention for committing to repositories, some of the most important keywords are:
fix:
A commit of the type fix patches a bug in your codebase (this correlates with PATCH in Semantic Versioning).
$ git commit -m "fix(<category>): my new fix"
feat:
A commit of the type feat introduces a new feature to the codebase (this correlates with MINOR in Semantic Versioning).
$ git commit -m "feat(<category>): my new feature"
BREAKING CHANGE
A commit that has a footer BREAKING CHANGE:, or appends a ! after the type/scope, introduces a breaking API change (correlating with MAJOR in Semantic Versioning). A BREAKING CHANGE can be part of commits of any type.
# Breaking Fix
$ git commit -m "fix!(<category>): my breaking fix"