mirror of
https://github.com/ARM-software/arm-trusted-firmware.git
synced 2025-04-15 00:54:22 +00:00
9a13b07f6a
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>
73 lines
2 KiB
JavaScript
73 lines
2 KiB
JavaScript
/*
|
|
* Copyright (c) 2021, Arm Limited. All rights reserved.
|
|
*
|
|
* SPDX-License-Identifier: BSD-3-Clause
|
|
*/
|
|
|
|
/* eslint-env es6 */
|
|
|
|
"use strict";
|
|
|
|
const fs = require("fs");
|
|
const yaml = require("js-yaml");
|
|
|
|
const { "trailer-exists": trailerExists } = require("@commitlint/rules").default;
|
|
|
|
/*
|
|
* The types and scopes accepted by both Commitlint and Commitizen are defined by the changelog
|
|
* configuration file - `changelog.yaml` - as they decide which section of the changelog commits
|
|
* with a given type and scope are placed in.
|
|
*/
|
|
|
|
let changelog;
|
|
|
|
try {
|
|
const contents = fs.readFileSync("changelog.yaml", "utf8");
|
|
|
|
changelog = yaml.load(contents);
|
|
} catch (err) {
|
|
console.log(err);
|
|
|
|
throw err;
|
|
}
|
|
|
|
function getTypes(sections) {
|
|
return sections.map(section => section.type)
|
|
}
|
|
|
|
function getScopes(subsections) {
|
|
return subsections.flatMap(subsection => {
|
|
const scope = subsection.scope ? [ subsection.scope ] : [];
|
|
const subscopes = getScopes(subsection.subsections || []);
|
|
|
|
return scope.concat(subscopes);
|
|
})
|
|
};
|
|
|
|
const types = getTypes(changelog.sections).sort(); /* Sort alphabetically */
|
|
const scopes = getScopes(changelog.subsections).sort(); /* Sort alphabetically */
|
|
|
|
module.exports = {
|
|
extends: ["@commitlint/config-conventional"],
|
|
plugins: [
|
|
{
|
|
rules: {
|
|
"signed-off-by-exists": trailerExists,
|
|
"change-id-exists": trailerExists,
|
|
},
|
|
},
|
|
],
|
|
rules: {
|
|
"header-max-length": [1, "always", 50], /* Warning */
|
|
"body-max-line-length": [1, "always", 72], /* Warning */
|
|
|
|
"change-id-exists": [1, "always", "Change-Id:"], /* Warning */
|
|
"signed-off-by-exists": [1, "always", "Signed-off-by:"], /* Warning */
|
|
|
|
"type-case": [2, "always", "lower-case" ], /* Error */
|
|
"type-enum": [2, "always", types], /* Error */
|
|
|
|
"scope-case": [2, "always", "lower-case"], /* Error */
|
|
"scope-enum": [1, "always", scopes] /* Warning */
|
|
},
|
|
};
|