Skip to content

docs: fix Conventional Commits PATCH rule #3628

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.

Sign up for GitHub

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

Merged
arturcic merged 5 commits into from
Sep 4, 2023
Merged

docs: fix Conventional Commits PATCH rule #3628

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e397c87
docs: fix conventional commit rules
BinToss Jul 18, 2023
32e446b
docs: add note regarding semantic-release's arbitrary `revert` rule
BinToss Jul 18, 2023
326eb80
docs: warn about semantic-release/commit-analyzer's use of micromatch…
BinToss Jul 18, 2023
a1cab94
docs: remove trailing whitespace
BinToss Jul 18, 2023
7a388f7
docs: add Conventional Commits multiple scopes delimiters
BinToss Jul 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions docs/input/docs/reference/version-increments.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,14 +95,18 @@ you can leverage this feature as follows:

```yaml
mode: MainLine # Only add this if you want every version to be created automatically on your main branch.
major-version-bump-message: "^(build|chore|ci|docs|feat|fix|perf|refactor|revert|style|test)(\\([\\w\\s-]*\\))?(!:|:.*\\n\\n((.+\\n)+\\n)?BREAKING CHANGE:\\s.+)"
minor-version-bump-message: "^(feat)(\\([\\w\\s-]*\\))?:"
patch-version-bump-message: "^(build|chore|ci|docs|fix|perf|refactor|revert|style|test)(\\([\\w\\s-]*\\))?:"
major-version-bump-message: "^(build|chore|ci|docs|feat|fix|perf|refactor|revert|style|test)(\\([\\w\\s-,/\\\\]*\\))?(!:|:.*\\n\\n((.+\\n)+\\n)?BREAKING CHANGE:\\s.+)"
minor-version-bump-message: "^(feat)(\\([\\w\\s-,/\\\\]*\\))?:"
patch-version-bump-message: "^(fix|perf)(\\([\\w\\s-,/\\\\]*\\))?:"
```

This will ensure that your version gets bumped according to the commits you've
created.

If your CI/CD workflow uses semantic-release's commit-analyzer, change `(fix|perf)` to `(fix|perf|revert)`. [Why?](https://github.com/semantic-release/commit-analyzer/blob/75c9c87c88772d7ded4ca9614852b42519e41931/lib/default-release-rules.js#L8C1-L8C38)

Alternatively, you can override this rule in the [configuration](https://github.com/semantic-release/commit-analyzer/tree/master#usage) of \@semantic-release/commit-analyzer. If you intend to write rules with patterns, note that instead of using Regular Expression, \@semantic-release/commit-analyzer uses [micromatch's glob implementation](https://github.com/micromatch/micromatch#matching-features).

### GitVersion.yml

The first is by setting the `next-version` property in the GitVersion.yml file.
Expand All @@ -116,7 +120,7 @@ from the branch name as a source. However, GitVersion can't use the [branch
name as a version source for _other branches_][faq-branch-name-source].

### Detached HEAD
If HEAD is in detached state tag will be `-no-branch-`.
If HEAD is in detached state tag will be `-no-branch-`.

Example: `0.0.1--no-branch-.1+4`

Expand Down