Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
commit-analyzer-cz
Manage
Activity
Members
Code
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Deploy
Releases
Package registry
Model registry
Operate
Terraform modules
Analyze
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
GitLab community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
GitHub Mirror
go-semantic-release
commit-analyzer-cz
Commits
79dcddff
Commit
79dcddff
authored
1 year ago
by
Christoph Witzko
Browse files
Options
Downloads
Patches
Plain Diff
docs: explain release rules
parent
7d9dae42
Branches
Branches containing commit
Tags
Tags containing commit
No related merge requests found
Changes
2
Show whitespace changes
Inline
Side-by-side
Showing
2 changed files
LICENSE
+1
-1
1 addition, 1 deletion
LICENSE
README.md
+30
-1
30 additions, 1 deletion
README.md
with
31 additions
and
2 deletions
LICENSE
+
1
−
1
View file @
79dcddff
Copyright (c) 202
0
Christoph Witzko
Copyright (c) 202
4
Christoph Witzko
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
...
...
This diff is collapsed.
Click to expand it.
README.md
+
30
−
1
View file @
79dcddff
...
...
@@ -38,6 +38,35 @@ A [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) analyze
Refs #133
```
## Customizable Release Rules
It is possible to customize the release rules by providing options to the analyzer. The following options are available:
| Option | Default |
|-----------------------|---------|
|
`major_release_rules`
|
`*!`
|
|
`minor_release_rules`
|
`feat`
|
|
`patch_release_rules`
|
`fix`
|
⚠️ Commits that contain
`BREAKING CHANGE(S)`
in their body will always result in a major release. This behavior cannot be customized yet.
### Rule Syntax
A rule may match a specific commit type, scope or both. The following syntax is supported:
`<type>(<scope>)<modifier>`
-
`<type>`
: The commit type, e.g.
`feat`
,
`fix`
,
`refactor`
.
-
`<scope>`
: The commit scope, e.g.
`lang`
,
`config`
. If left empty, the rule matches all scopes (
`*`
).
-
`<modifier>`
: The modifier, e.g.
`!`
for breaking changes. If left empty, the rule matches only commits without a modifier.
-
A
`*`
may be used as a wildcard for a type, scope or modifier.
### Example Rules
| Commit |
`feat`
(or
`feat(*)`
|
`*!`
(or
`*(*)!`
) |
`chore(deps)`
|
`*🚀`
|
|------------------------------------|----------------------|-------------------|---------------|-------|
|
`feat(ui): add button component`
| ✅ | ❌ | ❌ | ❌ |
|
`feat!: drop support for Go 1.17`
| ❌ | ✅ | ❌ | ❌ |
|
`chore(deps): update dependencies`
| ❌ | ❌ | ✅ | ❌ |
|
`refactor: remove unused code`
| ❌ | ❌ | ❌ | ❌ |
|
`fix🚀: correct minor typos`
| ❌ | ❌ | ❌ | ✅ |
## References
-
[
Conventional Commit v1.0.0 - Examples
](
https://www.conventionalcommits.org/en/v1.0.0/#examples
)
...
...
@@ -45,4 +74,4 @@ A [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) analyze
The
[
MIT License (MIT)
](
http://opensource.org/licenses/MIT
)
Copyright © 202
0
[
Christoph Witzko
](
https://twitter.com/christophwitzko
)
Copyright © 202
4
[
Christoph Witzko
](
https://twitter.com/christophwitzko
)
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment