Skip to content

chore(patch-release): add more release scope for semantic-release #890

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
merged 2 commits into from
Jan 31, 2025
Merged

chore(patch-release): add more release scope for semantic-release #890

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c7e93b3
chore: add more release scope for semantic-release
huxuan Jan 31, 2025
616b57c
update docs
huxuan Jan 31, 2025
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: 12 additions & 0 deletions .releaserc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,18 @@
"type": "test",
"release": false
},
{
"scope": "*major-release*",
"release": "major"
},
{
"scope": "*minor-release*",
"release": "minor"
},
{
"scope": "*patch-release*",
"release": "patch"
},
{
"scope": "*no-release*",
"release": false
Expand Down
19 changes: 11 additions & 8 deletions docs/management/release.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,31 +11,34 @@ The release configuration is located in the root directory of the project:

Based on this configuration, the following trigger rules apply:

* A **major** release is triggered by a 'BREAKING CHANGE' or 'BREAKING-CHANGE' in the footer of the commit message.
* A **minor** release is triggered when the latest commit type is `feat`.
* A **patch** release is triggered when the latest commit type is `fix`, `perf`, `refactor` or `revert`.
* No release is triggered if the latest commit type is any other type or has a `no-release` scope.
* A **major** release is triggered by a 'BREAKING CHANGE' or 'BREAKING-CHANGE' in the footer or has a `major-release` scope.
* A **minor** release is triggered when the commit type is `feat` or has a `minor-release` scope.
* A **patch** release is triggered when the commit type is `fix`, `perf`, `refactor` or `revert` or has a `patch-release` scope.
* No release is triggered if the commit type is any other type or has a `no-release` scope.

## Commit message examples

### Major release

```text
feat: drop Python 3.8 support
* ```text
feat: drop Python 3.8 support

BREAKING CHANGE: drop Python 3.8 support
```
BREAKING CHANGE: drop Python 3.8 support
```
* `chore(major-release): a major release`

### Minor release

* `feat: add an awesome feature`
* `chore(minor-release): a minor release`

### Patch release

* `fix: fix a silly bug`
* `perf: performance improvement for the core`
* `refactor: refactor the base module`
* `revert: revert a buggy implementation`
* `chore(patch-release): a patch release`

### No release

Expand Down
12 changes: 12 additions & 0 deletions template/.releaserc.json.jinja
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,18 @@
"type": "test",
"release": false
},
{
"scope": "*major-release*",
"release": "major"
},
{
"scope": "*minor-release*",
"release": "minor"
},
{
"scope": "*patch-release*",
"release": "patch"
},
{
"scope": "*no-release*",
"release": false
Expand Down
19 changes: 11 additions & 8 deletions template/docs/management/release.md.jinja
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,31 +11,34 @@ The release configuration is located in the root directory of the project:

Based on this configuration, the following trigger rules apply:

* A **major** release is triggered by a 'BREAKING CHANGE' or 'BREAKING-CHANGE' in the footer of the commit message.
* A **minor** release is triggered when the latest commit type is `feat`.
* A **patch** release is triggered when the latest commit type is `fix`, `perf`, `refactor` or `revert`.
* No release is triggered if the latest commit type is any other type or has a `no-release` scope.
* A **major** release is triggered by a 'BREAKING CHANGE' or 'BREAKING-CHANGE' in the footer or has a `major-release` scope.
* A **minor** release is triggered when the commit type is `feat` or has a `minor-release` scope.
* A **patch** release is triggered when the commit type is `fix`, `perf`, `refactor` or `revert` or has a `patch-release` scope.
* No release is triggered if the commit type is any other type or has a `no-release` scope.

## Commit message examples

### Major release

```text
feat: drop Python 3.8 support
* ```text
feat: drop Python 3.8 support

BREAKING CHANGE: drop Python 3.8 support
```
BREAKING CHANGE: drop Python 3.8 support
```
* `chore(major-release): a major release`

### Minor release

* `feat: add an awesome feature`
* `chore(minor-release): a minor release`

### Patch release

* `fix: fix a silly bug`
* `perf: performance improvement for the core`
* `refactor: refactor the base module`
* `revert: revert a buggy implementation`
* `chore(patch-release): a patch release`

### No release

Expand Down