Browse Source

build(changelog): pretend scope-less `build` changes have the `build` scope

In response to feedback provided during review of the v2.9 changelog,
commits with the `build` type and without a scope are now treated as
though they have the `build` scope as well.

Change-Id: I9628e0faf1fcf31fe88758ad3e75ca8febf1bb36
Signed-off-by: Chris Kay <chris.kay@arm.com>
pull/1999/head
Chris Kay 1 year ago
parent
commit
c84d632d0d
  1. 13
      tools/conventional-changelog-tf-a/index.js

13
tools/conventional-changelog-tf-a/index.js

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2021, Arm Limited. All rights reserved. * Copyright (c) 2021-2023, Arm Limited. All rights reserved.
* *
* SPDX-License-Identifier: BSD-3-Clause * SPDX-License-Identifier: BSD-3-Clause
*/ */
@ -166,6 +166,17 @@ function writerOpts(config) {
writerOpts.footerPartial = readFileSync(resolve(__dirname, "./templates/footer.hbs"), "utf-8"); writerOpts.footerPartial = readFileSync(resolve(__dirname, "./templates/footer.hbs"), "utf-8");
writerOpts.transform = function (commit, context) { writerOpts.transform = function (commit, context) {
/*
* Feedback on the generated changelog has shown that having build system changes
* appear at the top of a section throws some people off. We make an exception for
* scopeless `build`-type changes and treat them as though they actually have the
* `build` scope.
*/
if ((commit.type === "build") && (commit.scope == null)) {
commit.scope = "build";
}
/* /*
* Fix up commit trailers, which for some reason are not correctly recognized and * Fix up commit trailers, which for some reason are not correctly recognized and
* end up showing up in the breaking changes. * end up showing up in the breaking changes.

Loading…
Cancel
Save