https://github.com/codeinwp/conventional-changelog-simple-preset
https://github.com/codeinwp/conventional-changelog-simple-preset
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/codeinwp/conventional-changelog-simple-preset
- Owner: Codeinwp
- License: isc
- Created: 2019-12-19T17:02:37.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-08-07T08:22:55.000Z (11 months ago)
- Last Synced: 2025-02-10T07:05:30.517Z (5 months ago)
- Language: JavaScript
- Size: 36.1 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
## Simple changelog convention
Conventional changelog preset which triggers release based on the commits on the default branch ( master ).
The type of the release is triggered by the scope.
The release notes are generated based on the commit body.
### Examples
* `release: new version` will trigger a **patch** release with no release notes
* `release(minor): new version` will trigger a **minor** release with no release notes
```
release: new version
* Fix race condition
* Improve perfomance issues
```
will trigger a **patch** release with
```
* Fix race condition
* Improve perfomance issues
```
as release notes.
### How to use
In the release file you can add the following configuration
```json
{
"branch": "master",
"plugins": [
[
"@semantic-release/commit-analyzer",
{
"preset": "simple-preset",
"releaseRules": "conventional-changelog-simple-preset/release-rules"
}
],
[
"@semantic-release/changelog",
{
"changelogFile": "CHANGELOG.md"
}
],
[
"@semantic-release/release-notes-generator",
{
"preset": "simple-preset"
}
]
]
}
```