Skip to content

Commit

Permalink
ci: use custom conventional commit prefixes + don't enforce
Browse files Browse the repository at this point in the history
  • Loading branch information
mrcjkb committed Sep 12, 2023
1 parent 4988cf2 commit 0e6284c
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 23 deletions.
20 changes: 0 additions & 20 deletions .github/workflows/conventional-commit.yml

This file was deleted.

1 change: 1 addition & 0 deletions .github/workflows/release-please.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ jobs:
token: ${{ secrets.GH_TOKEN_FOR_UPDATES }}
release-type: simple
signoff: "Marc Jakobi<[email protected]>"
changelog-types: '[{"type":"feat","section":"Features","hidden":false},{"type":"fix","section":"Bug Fixes","hidden":false},{"type":"deps","section":"Dependencies","hidden":false}]'
- uses: actions/checkout@v4
- name: auto-merge
uses: reitermarkus/automerge@v2
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/update.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ jobs:
uses: DeterminateSystems/update-flake-lock@v20
with:
token: ${{ secrets.GH_TOKEN_FOR_UPDATES }}
pr-title: "fix(dependencies): update flake.lock" # Title of PR to be created
pr-title: "deps: update flake.lock" # Title of PR to be created
pr-labels: | # Labels to be set on the PR
dependencies
automated
Expand Down
16 changes: 14 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,17 @@ Contributions are more than welcome!

## Commit messages / PR titles

This project uses [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).
Please make sure your PR title matches the [`angular` preset](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular).
This project uses [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)
for PR titles, which become the commit messages after a squash merge.

The most important prefixes you should have in mind are:

- `feat:` which represents a new feature, and correlates to a [SemVer](https://semver.org/)
minor.
- `fix:` which represents bug fixes, and correlates to a SemVer patch.
- `deps:` which represents dependency updates, and correlates to a SemVer patch.
- `feat!:`, or `fix!:`, `refactor!:`, etc., which represent a breaking change
(indicated by the !).
- `docs:` which represents documentation, and does not correlate to a version bump.
- `chore:` which represents miscellaneous changes,
and does not correlate to a version bump.

0 comments on commit 0e6284c

Please sign in to comment.