semantic-release / semantic-release/release-notes-generator
I need to include other commits than `feat` and `fix`.
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 368
- Forks
- 55
- Avg merge
- 10m
- Merged PRs (30d)
- 1
Description
Hi Help wanted 🆘
I have a react app configured with GithubPages. I need to include commits like chore, style, refactor ..etc in the generated CHANGELOG.
This is my config .releaserc.json
{
"branches": [
{ "name": "main" },
{ "name": "pre/rc", "channel": "pre/rc", "prerelease": "rc" },
{ "name": "beta", "channel": "beta", "prerelease": true }
],
"plugins": [
[
"@semantic-release/commit-analyzer",
{
"preset": "angular",
"releaseRules": [
{ "type": "docs", "release": "patch" },
{ "type": "refactor", "release": "patch" },
{ "type": "style", "release": "patch" },
{ "type": "ci", "release": "patch" },
{ "type": "chore", "release": "patch" }
]
}
],
[
"@semantic-release/release-notes-generator",
{
"parserOpts": {
"noteKeywords": ["BREAKING CHANGE", "BREAKING CHANGES", "BREAKING"]
},
"preset": "conventionalcommits", // I used angular preset and failed too
"presetConfig": {
"types": [
{
"type": "breaking",
"section": "❗ Breaking ❗",
"hidden": false
},
{ "type": "feat", "section": "✨ Feature ✨", "hidden": false },
{ "type": "fix", "section": "🐛 Bugfix 🐛", "hidden": false },
{ "type": "hotfix", "section": "🔥 Hotfix 🔥", "hidden": false },
{
"type": "BREAKING",
"section": "❗ Breaking ❗",
"hidden": false
},
{ "type": "HOTFIX", "section": "🔥 Hotfix 🔥", "hidden": false }
]
}
}
],
[
"@semantic-release/changelog",
{
"changelogFile": "CHANGELOG.md"
}
],
[
"@semantic-release/git",
{
"assets": ["CHANGELOG.md"],
"message": "build: 🚀 ${nextRelease.gitTag} has been released \n\n${nextRelease.notes}"
}
],
[
"@semantic-release/github",
{
"assets": ["dist/assets/**"]
}
]
]
}
and this is the generated CHANGELOG.md
# 1.0.0 (2022-12-29)
### Features
- :sparkles: add 404 not found page ([3c862d3](https://github.com/tomavic/myreads-tracker/commit/3c862d39c7723715b2397908ab63b7d154d1daf6))
- :sparkles: add book details page ([556caca](https://github.com/tomavic/myreads-tracker/commit/556caca2e4086330cc9c2fe95fa94db3f1871491))
- :sparkles: add project files ([7805ac1](https://github.com/tomavic/myreads-tracker/commit/7805ac18bf1eee3da4549fb935cf2c943c217a86))
- :sparkles: first commit ([1a4b6f3](https://github.com/tomavic/myreads-tracker/commit/1a4b6f3b0fc33c94f78598aa3558daf2b4b06516))
- :sparkles: style and favicon ([9501b1c](https://github.com/tomavic/myreads-tracker/commit/9501b1c7f0a19814129c8f73952d475bc377d3c6))
- :sparkles: use `useRoutes` ([adbd18f](https://github.com/tomavic/myreads-tracker/commit/adbd18f34e13f18c72388474e42af20541cb1ab5))
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the .releaserc.json configuration and the generated CHANGELOG.md, then read how the release-notes-generator handles presetConfig.types and commit types. Reproduce the configuration with chore, style, and refactor commits and verify that those entries appear in the generated changelog under the intended sections.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- release
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100