release-please 14.2.3 → 14.3.1

package/CHANGELOG.md

@@ -4,6 +4,33 @@
 
 [1]: https://www.npmjs.com/package/release-please?activeTab=versions
 
+## [14.3.1](https://github.com/googleapis/release-please/compare/v14.3.0...v14.3.1) (2022-09-06)
+
+
+### Bug Fixes
+
+* **sentence-case:** handle multiple colons in subject ([0564594](https://github.com/googleapis/release-please/commit/05645949c771a3898a8521520322dd952c9aa6ff))
+
+## [14.3.0](https://github.com/googleapis/release-please/compare/v14.2.4...v14.3.0) (2022-08-31)
+
+
+### Features
+
+* introduce `sentence-case` plugin that capitalizes commit messages ([414eb5f](https://github.com/googleapis/release-please/commit/414eb5f716662569c72ff4cae2b1d1c95c0441ea))
+* introduce processCommits hook for plugins ([#1607](https://github.com/googleapis/release-please/issues/1607)) ([414eb5f](https://github.com/googleapis/release-please/commit/414eb5f716662569c72ff4cae2b1d1c95c0441ea))
+
+
+### Bug Fixes
+
+* add changelog-path to valid config schema ([#1612](https://github.com/googleapis/release-please/issues/1612)) ([c2937ba](https://github.com/googleapis/release-please/commit/c2937ba9f96e7d7c78332ceba94d1ebcee35768b))
+
+## [14.2.4](https://github.com/googleapis/release-please/compare/v14.2.3...v14.2.4) (2022-08-30)
+
+
+### Bug Fixes
+
+* prepend release notes to non-conforming changelog ([#1615](https://github.com/googleapis/release-please/issues/1615)) ([7d6c4c5](https://github.com/googleapis/release-please/commit/7d6c4c5aabd39436762253b019e17a5922ffa560))
+
 ## [14.2.3](https://github.com/googleapis/release-please/compare/v14.2.2...v14.2.3) (2022-08-30)
 
 

package/build/src/factories/plugin-factory.js

@@ -19,11 +19,13 @@ const cargo_workspace_1 = require("../plugins/cargo-workspace");
 const node_workspace_1 = require("../plugins/node-workspace");
 const maven_workspace_1 = require("../plugins/maven-workspace");
 const errors_1 = require("../errors");
+const sentence_case_1 = require("../plugins/sentence-case");
 const pluginFactories = {
     'linked-versions': options => new linked_versions_1.LinkedVersions(options.github, options.targetBranch, options.repositoryConfig, options.type.groupName, options.type.components),
     'cargo-workspace': options => new cargo_workspace_1.CargoWorkspace(options.github, options.targetBranch, options.repositoryConfig, options),
     'node-workspace': options => new node_workspace_1.NodeWorkspace(options.github, options.targetBranch, options.repositoryConfig, options),
     'maven-workspace': options => new maven_workspace_1.MavenWorkspace(options.github, options.targetBranch, options.repositoryConfig, options),
+    'sentence-case': options => new sentence_case_1.SentenceCase(options.github, options.targetBranch, options.repositoryConfig, options.type.specialWords),
 };
 function buildPlugin(options) {
     if (typeof options.type === 'object') {

package/build/src/manifest.d.ts

@@ -132,10 +132,13 @@ export interface LinkedVersionPluginConfig extends ConfigurablePluginType {
     components: string[];
     merge?: boolean;
 }
+export interface SentenceCasePluginConfig extends ConfigurablePluginType {
+    specialWords?: string[];
+}
 export interface WorkspacePluginConfig extends ConfigurablePluginType {
     merge?: boolean;
 }
-export declare type PluginType = DirectPluginType | ConfigurablePluginType | LinkedVersionPluginConfig | WorkspacePluginConfig;
+export declare type PluginType = DirectPluginType | ConfigurablePluginType | LinkedVersionPluginConfig | SentenceCasePluginConfig | WorkspacePluginConfig;
 /**
  * This is the schema of the manifest config json
  */

package/build/src/manifest.js

@@ -329,7 +329,13 @@ class Manifest {
             this.logger.info(`Building candidate release pull request for path: ${path}`);
             this.logger.debug(`type: ${config.releaseType}`);
             this.logger.debug(`targetBranch: ${this.targetBranch}`);
-            const pathCommits = commitsPerPath[path];
+            let pathCommits = commitsPerPath[path];
+            // The processCommits hook can be implemented by plugins to
+            // post-process commits. This can be used to perform cleanup, e.g,, sentence
+            // casing all commit messages:
+            for (const plugin of plugins) {
+                pathCommits = plugin.processCommits(pathCommits);
+            }
             this.logger.debug(`commits: ${pathCommits.length}`);
             const latestReleasePullRequest = releasePullRequestsBySha[releaseShasByPath[path]];
             if (!latestReleasePullRequest) {

package/build/src/plugin.d.ts

@@ -16,6 +16,12 @@ export declare abstract class ManifestPlugin {
     readonly repositoryConfig: RepositoryConfig;
     protected logger: Logger;
     constructor(github: GitHub, targetBranch: string, repositoryConfig: RepositoryConfig, logger?: Logger);
+    /**
+     * Perform post-processing on commits, e.g, sentence casing them.
+     * @param {Commit[]} commits The set of commits that will feed into release pull request.
+     * @returns {Commit[]} The modified commit objects.
+     */
+    processCommits(commits: Commit[]): Commit[];
     /**
      * Post-process candidate pull requests.
      * @param {CandidateReleasePullRequest[]} pullRequests Candidate pull requests

package/build/src/plugin.js

@@ -28,6 +28,16 @@ class ManifestPlugin {
         this.repositoryConfig = repositoryConfig;
         this.logger = logger;
     }
+    /**
+     * Perform post-processing on commits, e.g, sentence casing them.
+     * @param {Commit[]} commits The set of commits that will feed into release pull request.
+     * @returns {Commit[]} The modified commit objects.
+     */
+    // TODO: for next major version, let's run the default conventional commit parser earlier
+    // (outside of the strategy classes) and pass in the ConventionalCommit[] objects in.
+    processCommits(commits) {
+        return commits;
+    }
     /**
      * Post-process candidate pull requests.
      * @param {CandidateReleasePullRequest[]} pullRequests Candidate pull requests

package/build/src/plugins/sentence-case.d.ts

@@ -0,0 +1,19 @@
+import { ManifestPlugin } from '../plugin';
+import { GitHub } from '../github';
+import { RepositoryConfig } from '../manifest';
+import { Commit } from '../commit';
+/**
+ * This plugin converts commit messages to sentence case, for the benefit
+ * of the generated CHANGELOG.
+ */
+export declare class SentenceCase extends ManifestPlugin {
+    specialWords: Set<string>;
+    constructor(github: GitHub, targetBranch: string, repositoryConfig: RepositoryConfig, specialWords?: Array<string>);
+    /**
+     * Perform post-processing on commits, e.g, sentence casing them.
+     * @param {Commit[]} commits The set of commits that will feed into release pull request.
+     * @returns {Commit[]} The modified commit objects.
+     */
+    processCommits(commits: Commit[]): Commit[];
+    toUpperCase(word: string): string;
+}

package/build/src/plugins/sentence-case.js

@@ -0,0 +1,77 @@
+"use strict";
+// Copyright 2022 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SentenceCase = void 0;
+const plugin_1 = require("../plugin");
+// A list of words that should not be converted to uppercase:
+const SPECIAL_WORDS = ['gRPC', 'npm'];
+/**
+ * This plugin converts commit messages to sentence case, for the benefit
+ * of the generated CHANGELOG.
+ */
+class SentenceCase extends plugin_1.ManifestPlugin {
+    constructor(github, targetBranch, repositoryConfig, specialWords) {
+        super(github, targetBranch, repositoryConfig);
+        this.specialWords = new Set(specialWords ? [...specialWords] : SPECIAL_WORDS);
+    }
+    /**
+     * Perform post-processing on commits, e.g, sentence casing them.
+     * @param {Commit[]} commits The set of commits that will feed into release pull request.
+     * @returns {Commit[]} The modified commit objects.
+     */
+    processCommits(commits) {
+        this.logger.info(`SentenceCase processing ${commits.length} commits`);
+        for (const commit of commits) {
+            // Check whether commit is in conventional commit format, if it is
+            // we'll split the string by type and description:
+            if (commit.message.includes(':')) {
+                const splitMessage = commit.message.split(':');
+                let prefix = splitMessage[0];
+                prefix += ': ';
+                let suffix = splitMessage.slice(1).join(':').trim();
+                // Extract the first word from the rest of the string:
+                const match = /\s|$/.exec(suffix);
+                if (match) {
+                    const endFirstWord = match.index;
+                    const firstWord = suffix.slice(0, endFirstWord);
+                    suffix = suffix.slice(endFirstWord);
+                    // Put the string back together again:
+                    commit.message = `${prefix}${this.toUpperCase(firstWord)}${suffix}`;
+                }
+            }
+        }
+        return commits;
+    }
+    /*
+     * Convert a string to upper case, taking into account a dictionary of
+     * common lowercase words, e.g., gRPC, npm.
+     *
+     * @param {string} word The original word.
+     * @returns {string} The word, now upper case.
+     */
+    toUpperCase(word) {
+        if (this.specialWords.has(word)) {
+            return word;
+        }
+        if (word.match(/^[a-z]/)) {
+            return word.charAt(0).toUpperCase() + word.slice(1);
+        }
+        else {
+            return word;
+        }
+    }
+}
+exports.SentenceCase = SentenceCase;
+//# sourceMappingURL=sentence-case.js.map

package/build/src/updaters/changelog.js

@@ -28,7 +28,12 @@ class Changelog extends default_1.DefaultUpdater {
         // Handle both H2 (features/BREAKING CHANGES) and H3 (fixes).
         const lastEntryIndex = content.search(this.versionHeaderRegex);
         if (lastEntryIndex === -1) {
-            return `${this.header()}\n${this.changelogEntry}\n`;
+            if (content) {
+                return `${this.header()}\n${this.changelogEntry}\n\n${adjustHeaders(content).trim()}\n`;
+            }
+            else {
+                return `${this.header()}\n${this.changelogEntry}\n`;
+            }
         }
         else {
             const before = content.slice(0, lastEntryIndex);
@@ -43,4 +48,8 @@ class Changelog extends default_1.DefaultUpdater {
     }
 }
 exports.Changelog = Changelog;
+// Helper to increase markdown H1 headers to H2
+function adjustHeaders(content) {
+    return content.replace(/^#(\s)/gm, '##$1');
+}
 //# sourceMappingURL=changelog.js.map

package/build/src/updaters/changelog.js.map

@@ -1 +1 @@
-{"version":3,"file":"changelog.js","sourceRoot":"","sources":["../../../src/updaters/changelog.ts"],"names":[],"mappings":";AAAA,4BAA4B;AAC5B,EAAE;AACF,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,kDAAkD;AAClD,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;;;AAEjC,uCAAwD;AAOxD,MAAM,4BAA4B,GAAG,iBAAiB,CAAC;AAEvD,MAAa,SAAU,SAAQ,wBAAc;IAI3C,YAAY,OAAyB;;QACnC,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC;QAC7C,IAAI,CAAC,kBAAkB,GAAG,IAAI,MAAM,CAClC,MAAA,OAAO,CAAC,kBAAkB,mCAAI,4BAA4B,EAC1D,GAAG,CACJ,CAAC;IACJ,CAAC;IAED,aAAa,CAAC,OAA2B;QACvC,OAAO,GAAG,OAAO,IAAI,EAAE,CAAC;QACxB,6DAA6D;QAC7D,MAAM,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;QAC/D,IAAI,cAAc,KAAK,CAAC,CAAC,EAAE;YACzB,OAAO,GAAG,IAAI,CAAC,MAAM,EAAE,KAAK,IAAI,CAAC,cAAc,IAAI,CAAC;SACrD;aAAM;YACL,MAAM,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC;YAChD,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;YAC5C,OAAO,GAAG,MAAM,KAAK,IAAI,CAAC,cAAc,KAAK,KAAK,EAAE,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC;SACpE;IACH,CAAC;IACO,MAAM;QACZ,OAAO;;CAEV,CAAC;IACA,CAAC;CACF;AA9BD,8BA8BC"}
+{"version":3,"file":"changelog.js","sourceRoot":"","sources":["../../../src/updaters/changelog.ts"],"names":[],"mappings":";AAAA,4BAA4B;AAC5B,EAAE;AACF,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,kDAAkD;AAClD,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;;;AAEjC,uCAAwD;AAOxD,MAAM,4BAA4B,GAAG,iBAAiB,CAAC;AAEvD,MAAa,SAAU,SAAQ,wBAAc;IAI3C,YAAY,OAAyB;;QACnC,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC;QAC7C,IAAI,CAAC,kBAAkB,GAAG,IAAI,MAAM,CAClC,MAAA,OAAO,CAAC,kBAAkB,mCAAI,4BAA4B,EAC1D,GAAG,CACJ,CAAC;IACJ,CAAC;IAED,aAAa,CAAC,OAA2B;QACvC,OAAO,GAAG,OAAO,IAAI,EAAE,CAAC;QACxB,6DAA6D;QAC7D,MAAM,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;QAC/D,IAAI,cAAc,KAAK,CAAC,CAAC,EAAE;YACzB,IAAI,OAAO,EAAE;gBACX,OAAO,GAAG,IAAI,CAAC,MAAM,EAAE,KAAK,IAAI,CAAC,cAAc,OAAO,aAAa,CACjE,OAAO,CACR,CAAC,IAAI,EAAE,IAAI,CAAC;aACd;iBAAM;gBACL,OAAO,GAAG,IAAI,CAAC,MAAM,EAAE,KAAK,IAAI,CAAC,cAAc,IAAI,CAAC;aACrD;SACF;aAAM;YACL,MAAM,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC;YAChD,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;YAC5C,OAAO,GAAG,MAAM,KAAK,IAAI,CAAC,cAAc,KAAK,KAAK,EAAE,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC;SACpE;IACH,CAAC;IACO,MAAM;QACZ,OAAO;;CAEV,CAAC;IACA,CAAC;CACF;AApCD,8BAoCC;AAED,+CAA+C;AAC/C,SAAS,aAAa,CAAC,OAAe;IACpC,OAAO,OAAO,CAAC,OAAO,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;AAC7C,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "release-please",
-  "version": "14.2.3",
+  "version": "14.3.1",
   "description": "generate release PRs based on the conventionalcommits.org spec",
   "main": "./build/src/index.js",
   "bin": "./build/src/bin/release-please.js",

package/schemas/config.json

@@ -91,6 +91,10 @@
           "description": "Generate changelog links to this GitHub host. Useful for running against GitHub Enterprise.",
           "type": "string"
         },
+        "changelog-path": {
+          "description": "Path to the file that tracks release note changes. Defaults to `CHANGELOG.md`.",
+          "type": "string"
+        },
         "pull-request-title-pattern": {
           "description": "Customize the release pull request title.",
           "type": "string"
@@ -249,6 +253,13 @@
                   "merge": {
                     "description": "Whether to merge in-scope pull requests into a combined release pull request. Defaults to `true`.",
                     "type": "boolean"
+                  },
+                  "specialWords": {
+                    "description": "Words that sentence casing logic will not be applied to",
+                    "type": "array",
+                    "items": {
+                      "type": "string"
+                    }
                   }
                 },
                 "required": ["type", "groupName", "components"]
@@ -332,6 +343,7 @@
     "include-v-in-tag": true,
     "changelog-type": true,
     "changelog-host": true,
+    "changelog-path": true,
     "pull-request-title-pattern": true,
     "pull-request-header": true,
     "separate-pull-requests": true,