After you've reviewed these contribution guidelines, you'll be all set to
contribute to this project.
CONTRIBUTING.md 1.48 KiB
Git Commit Guidelines
This project uses Semantic Versioning. We use commit messages to automatically determine the version bumps, so they should adhere to the conventions of Conventional Commits (v1.0.0-beta.2).
TL;DR
- Commit messages starting with
fix:trigger a patch version bump - Commit messages starting with
feat:trigger a minor version bump - Commit messages starting with
BREAKING CHANGE:trigger a major version bump.
Automatic versioning
Each push to master triggers a semantic-release
CI job that determines and pushes a new version tag (if any) based on the
last version tagged and the new commits pushed. Notice that this means that if a
Merge Request contains, for example, several feat: commits, only one minor
version bump will occur on merge. If your Merge Request includes several commits
you may prefer to ignore the prefix on each individual commit and instead add
an empty commit sumarizing your changes like so:
git commit --allow-empty -m '[BREAKING CHANGE|feat|fix]: <changelog summary message
### Stable tag
This project updates a `stable:latest` tag in the container registry which
tracks the latest build of the image specified in `STABLE_VERSION` in
`.gitlab-ci.yml`. Simply update this to reflect what version series is
considered stable by upstream and the `stable:latest` tag will be updated
automatically.