summaryrefslogtreecommitdiff
path: root/.cz.json
diff options
context:
space:
mode:
authorChris Kay <chris.kay@arm.com>2021-11-09 20:05:38 +0000
committerChris Kay <chris.kay@arm.com>2021-11-17 16:04:37 +0000
commitc4e8edab2174fa9be35f6c9b0cee52ec6397ecc7 (patch)
tree1adaab511ad93316da0ea2336bb0e7369f81a5ca /.cz.json
parentc76556a01769dd699c437ac4390b11dec38017c6 (diff)
downloadarm-trusted-firmware-c4e8edab2174fa9be35f6c9b0cee52ec6397ecc7.tar.gz
build(docs): introduce release script
This change introduces a new NPM run script to automatically generate the release changelog, as well as bump version numbers across the code-base and create the release tag. This script runs [Standard Version] to execute this, which is a tool designed around automating substantial parts of the release process. This can be done by running: npm run release -- [<standard-version args>] Standard Version expects the project to adhere to the [Semantic Versioning] convention which TF-A does not, so you may need to specify the version manually, e.g.: npm run release -- --release-as 2.6.0 Individual steps of the release process may also be skipped at-will, which may be necessary when, for example, tweaking the changelog: npm run release -- --skip.commit --skip.tag Standard Version is configured by the `.versionrc.js` file, which contains information about the Conventional Commits types and scopes used by the project, and how they map to the changelog. To maintain continuity with the existing changelog style - at least to the extent possible in the move from manual to automatic creation - a customized changelog template has been introduced, based on the Conventional Commits template provided by Standard Version. This template package extends the Conventional Commits template package by introducing support for parsing the Conventional Commits scopes into changelog sections, similarly to how they were previously organized. [Standard Version]: https://github.com/conventional-changelog/standard-version [Semantic Versioning]: https://semver.org Change-Id: I5bafa512daedc631baae951651c38c1c62046b0a Signed-off-by: Chris Kay <chris.kay@arm.com>
Diffstat (limited to '.cz.json')
-rw-r--r--.cz.json71
1 files changed, 69 insertions, 2 deletions
diff --git a/.cz.json b/.cz.json
index cb500bac4..97d485033 100644
--- a/.cz.json
+++ b/.cz.json
@@ -1,5 +1,72 @@
{
"path": "./node_modules/cz-conventional-changelog",
"maxHeaderWidth": 50,
- "maxLineWidth": 72
-} \ No newline at end of file
+ "maxLineWidth": 72,
+ "types": [
+ {
+ "type": "feat",
+ "title": "New Features",
+ "description": "A new feature"
+ },
+ {
+ "type": "fix",
+ "title": "Resolved Issues",
+ "description": "A bug fix"
+ },
+ {
+ "type": "build",
+ "title": "Build System",
+ "description": "Changes that affect the build system or external dependencies",
+ "hidden": true
+ },
+ {
+ "type": "ci",
+ "title": "Continuous Integration",
+ "description": "Changes to our CI configuration files and scripts",
+ "hidden": true
+ },
+ {
+ "type": "docs",
+ "title": "Build System",
+ "description": "Documentation-only changes",
+ "hidden": true
+ },
+ {
+ "type": "perf",
+ "title": "Performance Improvements",
+ "description": "A code change that improves performance",
+ "hidden": true
+ },
+ {
+ "type": "refactor",
+ "title": "Code Refactoring",
+ "description": "A code change that neither fixes a bug nor adds a feature",
+ "hidden": true
+ },
+ {
+ "type": "revert",
+ "title": "Reverted Changes",
+ "description": "Changes that revert a previous change",
+ "hidden": true
+ },
+ {
+ "type": "style",
+ "title": "Style",
+ "description": "Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc.)",
+ "hidden": true
+ },
+ {
+ "type": "test",
+ "title": "Tests",
+ "description": "Adding missing tests or correcting existing tests",
+ "hidden": true
+ },
+ {
+ "type": "chore",
+ "title": "Miscellaneous",
+ "description": "Any other change",
+ "hidden": true
+ }
+ ],
+ "sections": []
+}