Merge "build(commitlint): treat wrong scopes as error" into integration

build(commitlint): treat wrong scopes as error

The commitlint checker treats scopes that are not listed in the
changelog.yaml file as warnings. This is then usually overlooked, as
commitlint checker

build(commitlint): treat wrong scopes as error

The commitlint checker treats scopes that are not listed in the
changelog.yaml file as warnings. This is then usually overlooked, as
commitlint checker passes with warnings in CI and some patches with
wrong scope can be merged. The maintainers doing the release note will
then have to deal with those patches manually.

Signed-off-by: Yann Gautier <yann.gautier@st.com>
Change-Id: Ica5f581ce7b8c1adbe35f5ab3e6870d9a07807fd

show more ...

Merge "build(npm): update Node.js and all packages" into integration

build(npm): update Node.js and all packages

This change updates the Node Version Manager version file to the latest
long-term release version of Node.js, v20.11.1, and the Node.js Package
Manager pa

build(npm): update Node.js and all packages

This change updates the Node Version Manager version file to the latest
long-term release version of Node.js, v20.11.1, and the Node.js Package
Manager package file to require Node.js version v20 or later.

Additionally, all Node.js modules have been updated, as some packages
required additional accommodations to be made compatible with this
version of Node.js.

As part of this, the `.commitlintrc.js` has been rewritten from CommonJS
to ECMAScript. There should be no impact on the behaviour of Commitlint,
but this was was a requirement to allow Commitlint to continue using it
for configuration.

Change-Id: I7043faabc516c58edda9e58848b0569e2158b271
Signed-off-by: Chris Kay <chris.kay@arm.com>

show more ...

Merge "build(commitlint): make the scope optional" into integration

build(commitlint): make the scope optional

In all TF-A commit messages, the first line must comply to the
following format:

type(scope): description

Although the conventional commits specificati

build(commitlint): make the scope optional

In all TF-A commit messages, the first line must comply to the
following format:

type(scope): description

Although the conventional commits specification says that the scope
above is optional, we have made it mandatory in TF-A and the following
error message is printed if no scope is provided:

scope may not be empty [scope-empty]

However, this can be too restrictive for some types of commits. For
example, it is typically hard to choose a scope for documentation
patches which modify several documents of different natures.

Lift this restriction in the tools and leave it up to the developer to
decide whether a scope is needed or not.

Change-Id: I9d35e7790fc3fa74651794216fe8db265ad09982
Signed-off-by: Sandrine Bailleux <sandrine.bailleux@arm.com>

show more ...

Merge changes from topic "ck/changelog" into integration

* changes:
build(npm): mandate Node.js engine version
docs(changelog): fix broken version bumping
docs(changelog): fix version tag link

Merge changes from topic "ck/changelog" into integration

* changes:
build(npm): mandate Node.js engine version
docs(changelog): fix broken version bumping
docs(changelog): fix version tag links
refactor(hooks): replace cz-conventional-changelog with cz-commitlint
style(commitlint): reorder header/body max line length fields
chore(npm): update package versions/license

show more ...

refactor(hooks): replace cz-conventional-changelog with cz-commitlint

This change replaces cz-conventional-changelog with cz-commitlint, which
automatically configures Commitizen using our commitlin

refactor(hooks): replace cz-conventional-changelog with cz-commitlint

This change replaces cz-conventional-changelog with cz-commitlint, which
automatically configures Commitizen using our commitlint configuration
file. Currently, we use some manual Javascript magic to load our
Commitizen configuration into commitlint (the opposite of what's
introduced by this change), which can be removed.

With this change, we also move our commitlint configuration into a
new `changelog.yaml` file. This file holds the same data as `.cz.json`
previously did.

Change-Id: I14ff2308f1a0b2b293c2128b28ca2df578ce9c1c
Signed-off-by: Chris Kay <chris.kay@arm.com>

show more ...

style(commitlint): reorder header/body max line length fields

This change simply reorders the `body-max-line-length` and
`header-max-line-length` fields to be in the order that most people
mentally

style(commitlint): reorder header/body max line length fields

This change simply reorders the `body-max-line-length` and
`header-max-line-length` fields to be in the order that most people
mentally expect. This has no actual function impact.

Change-Id: Ice0db951e4049baaf4de9372255407adc4e3bf66
Signed-off-by: Chris Kay <chris.kay@arm.com>

show more ...

Merge "fix(commitlint): change scope-case to lower-case" into integration

fix(commitlint): change scope-case to lower-case

This avoids errors when mixing letters and numbers in the scope.

Change-Id: Icd2151d5b42b02ced0d801691ffb5997f4be2a1e
Signed-off-by: Yann Gautier <y

fix(commitlint): change scope-case to lower-case

This avoids errors when mixing letters and numbers in the scope.

Change-Id: Icd2151d5b42b02ced0d801691ffb5997f4be2a1e
Signed-off-by: Yann Gautier <yann.gautier@st.com>

show more ...

Merge changes from topic "ck/changelog" into integration

* changes:
docs(changelog): categorize scopes
docs(commit-style): add commit style documentation
build(docs): introduce release script

Merge changes from topic "ck/changelog" into integration

* changes:
docs(changelog): categorize scopes
docs(commit-style): add commit style documentation
build(docs): introduce release script
build(docs): add support for Markdown documentation
build(hooks): add commitlint checks for trailers
build(npm): add Standard Version v9.3.2
build(npm): add additional package metadata
build(npm): add license field
build(npm): update Husky to v7.0.4
build(npm): update commitlint to v14.1.0
build(npm): update lockfile format to v2
docs(prerequisites): update to Node.js v16
build(docs): update Python dependencies
build(docs): pin Python dependencies

show more ...

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

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>

show more ...

build(hooks): add commitlint checks for trailers

This change adds checks for the `Change-Id` and `Signed-off-by`
trailers. These are already required by Gerrit, so they have been
configured as warni

build(hooks): add commitlint checks for trailers

This change adds checks for the `Change-Id` and `Signed-off-by`
trailers. These are already required by Gerrit, so they have been
configured as warnings as an early heads-up after committing without
needing to push.

This also renames the commitlint configuration file to align it with
the style used by Standard Version when it's eventually introduced:

`commitlint.config.js` -> `.commitlintrc.js`

Change-Id: I4e3c158e6b3a5407fabd873360d5efce86ebd19e
Signed-off-by: Chris Kay <chris.kay@arm.com>

show more ...