release-please
Release Documentation with release-please
release-please by Google reads your Conventional Commits and automatically:
- Maintains a Release PR that stays updated as you push commits
- Generates a CHANGELOG.md from your commit history
- Creates GitHub Releases with proper tags when you merge the PR
release-please-config.json
{
"$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json",
"release-type": "simple",
"packages": {
".": {
"changelog-path": "CHANGELOG.md",
"include-component-in-tag": false
}
},
"changelog-sections": [
{ "type": "feat", "section": "✨ New Features" },
{ "type": "fix", "section": "🐛 Bug Fixes" },
{ "type": "refactor", "section": "♻️ Refactoring" },
{ "type": "docs", "section": "📝 Documentation" },
{ "type": "chore", "section": "🔧 Maintenance", "hidden": true },
{ "type": "style", "section": "💄 Style", "hidden": true },
{ "type": "ci", "section": "👷 CI", "hidden": true },
{ "type": "test", "section": "✅ Tests", "hidden": true }
]
}.release-please-manifest.json
{
".": "0.1.0"
}Set "0.1.0" to whatever version makes sense for where you are now.