Replaces the 8-line placeholder with a complete README covering all four modules, platform capabilities, quick start, dev setup, configuration reference, and deployment links. Badges use dynamic shields.io URLs so version/CI status update automatically on each release. Wires README review into the release pipeline via a release-it before:git:release hook and a new item in the pre-deploy checklist.
36 lines
1.0 KiB
JSON
36 lines
1.0 KiB
JSON
{
|
|
"npm": {
|
|
"publish": false
|
|
},
|
|
"git": {
|
|
"commitMessage": "chore: release v${version}",
|
|
"tagName": "v${version}",
|
|
"requireBranch": "main"
|
|
},
|
|
"github": {
|
|
"release": true,
|
|
"releaseName": "v${version}"
|
|
},
|
|
"hooks": {
|
|
"before:git:release": "echo 'Check: README.md reflects current modules and env vars before tagging'"
|
|
},
|
|
"plugins": {
|
|
"@release-it/conventional-changelog": {
|
|
"preset": {
|
|
"name": "conventionalcommits",
|
|
"types": [
|
|
{ "type": "feat", "section": "Features" },
|
|
{ "type": "fix", "section": "Bug Fixes" },
|
|
{ "type": "perf", "section": "Performance" },
|
|
{ "type": "refactor", "section": "Refactoring" },
|
|
{ "type": "docs", "section": "Documentation" },
|
|
{ "type": "chore", "section": "Maintenance", "hidden": true },
|
|
{ "type": "ci", "section": "CI/CD", "hidden": true },
|
|
{ "type": "test", "section": "Tests", "hidden": true }
|
|
]
|
|
},
|
|
"infile": "CHANGELOG.md"
|
|
}
|
|
}
|
|
}
|