arm-trusted-firmware/docs
Chris Kay c4e8edab21 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>
2021-11-17 16:04:37 +00:00
..
_static/css docs(threat model): add TF-A threat model 2021-04-30 17:59:22 +02:00
about build(docs): introduce release script 2021-11-17 16:04:37 +00:00
components Merge "docs(spm): document s-el0 partition support" into integration 2021-11-17 13:54:04 +01:00
design docs(rme): add description of TF-A changes for RME 2021-11-15 22:20:07 +01:00
design_documents feat(measured boot): add documentation to build and run PoC 2021-11-08 10:49:26 +00:00
getting_started docs(prerequisites): update to Node.js v16 2021-11-17 16:04:35 +00:00
perf doc: Fix some broken links 2020-07-01 13:57:20 +02:00
plat chore(docs): update supported FVP models doc 2021-11-04 11:34:17 +01:00
process fix(docs-contributing.rst): fix formatting for code snippet 2021-09-09 14:25:16 +01:00
resources docs(rme): add description of TF-A changes for RME 2021-11-15 22:20:07 +01:00
security_advisories docs: Update SMCCC doc, other changes for release 2020-04-16 10:03:39 -05:00
threat_model docs(rme): add description of TF-A changes for RME 2021-11-15 22:20:07 +01:00
Makefile doc: Treat Sphinx warnings as errors 2020-04-21 09:37:47 +00:00
change-log.md build(docs): introduce release script 2021-11-17 16:04:37 +00:00
conf.py build(docs): add support for Markdown documentation 2021-11-17 16:04:36 +00:00
global_substitutions.txt fix(docs): fix `FF-A` substitution 2021-11-17 16:04:34 +00:00
glossary.rst feat(mpmm): add support for MPMM 2021-10-26 12:15:42 +01:00
index.rst docs(fwu): add firmware update documentation 2021-08-02 17:15:41 +01:00
license.rst refactor(dt-bindings): align irq bindings with kernel 2021-06-14 10:05:48 +02:00
requirements.in build(docs): add support for Markdown documentation 2021-11-17 16:04:36 +00:00
requirements.txt build(docs): add support for Markdown documentation 2021-11-17 16:04:36 +00:00