release-please 13.4.2 → 13.4.6

package/CHANGELOG.md

@@ -4,6 +4,37 @@
 
 [1]: https://www.npmjs.com/package/release-please?activeTab=versions
 
+### [13.4.6](https://github.com/googleapis/release-please/compare/v13.4.5...v13.4.6) (2022-02-01)
+
+
+### Bug Fixes
+
+* cargo workspace cargo lock handling ([#1260](https://github.com/googleapis/release-please/issues/1260)) ([55e9d38](https://github.com/googleapis/release-please/commit/55e9d3822d4d36d3123231f22dccacf35910929e))
+* krm blueprints should update yaml files ([#1269](https://github.com/googleapis/release-please/issues/1269)) ([d6ef98a](https://github.com/googleapis/release-please/commit/d6ef98a7031b599e38a505af2ffc51e85b3c6da6)), closes [#1268](https://github.com/googleapis/release-please/issues/1268)
+
+### [13.4.5](https://github.com/googleapis/release-please/compare/v13.4.4...v13.4.5) (2022-02-01)
+
+
+### Bug Fixes
+
+* read packageName from config ([#1270](https://github.com/googleapis/release-please/issues/1270)) ([e953e1a](https://github.com/googleapis/release-please/commit/e953e1a387f6124fbacb7952b5451ca43bd498fa))
+
+### [13.4.4](https://github.com/googleapis/release-please/compare/v13.4.3...v13.4.4) (2022-01-26)
+
+
+### Bug Fixes
+
+* delegate empty commit handling to strategies ([#1254](https://github.com/googleapis/release-please/issues/1254)) ([757f2a9](https://github.com/googleapis/release-please/commit/757f2a9304aec164632ee081b09d22595c5f1e67))
+* extra file should include strategy path ([#1187](https://github.com/googleapis/release-please/issues/1187)) ([c8fffb0](https://github.com/googleapis/release-please/commit/c8fffb0bca7be83487e9d2e3257277e8650cdfaf))
+
+### [13.4.3](https://github.com/googleapis/release-please/compare/v13.4.2...v13.4.3) (2022-01-24)
+
+
+### Bug Fixes
+
+* multi-component manifest release notes for single component release ([#1247](https://github.com/googleapis/release-please/issues/1247)) ([16aee09](https://github.com/googleapis/release-please/commit/16aee099c79d75853e565f83017745eef13b57fa))
+* release notes should parse initial version heading ([#1248](https://github.com/googleapis/release-please/issues/1248)) ([71dc495](https://github.com/googleapis/release-please/commit/71dc4954e2393f74c4442c021fcf6c8ee530b4ae))
+
 ### [13.4.2](https://github.com/googleapis/release-please/compare/v13.4.1...v13.4.2) (2022-01-21)
 
 

package/build/src/manifest.js

@@ -265,10 +265,6 @@ class Manifest {
             logger_1.logger.debug(`type: ${config.releaseType}`);
             logger_1.logger.debug(`targetBranch: ${this.targetBranch}`);
             const pathCommits = commitsAfterSha(path === exports.ROOT_PROJECT_PATH ? commits : commitsPerPath[path], releaseShasByPath[path]);
-            if (!pathCommits || pathCommits.length === 0) {
-                logger_1.logger.info(`No commits for path: ${path}, skipping`);
-                continue;
-            }
             logger_1.logger.debug(`commits: ${pathCommits.length}`);
             const latestReleasePullRequest = releasePullRequestsBySha[releaseShasByPath[path]];
             if (!latestReleasePullRequest) {

package/build/src/plugins/cargo-workspace.d.ts

@@ -45,6 +45,7 @@ export declare class CargoWorkspace extends WorkspacePlugin<CrateInfo> {
     protected bumpVersion(pkg: CrateInfo): Version;
     protected updateCandidate(existingCandidate: CandidateReleasePullRequest, pkg: CrateInfo, updatedVersions: VersionsMap): CandidateReleasePullRequest;
     protected newCandidate(pkg: CrateInfo, updatedVersions: VersionsMap): CandidateReleasePullRequest;
+    protected postProcessCandidates(candidates: CandidateReleasePullRequest[], updatedVersions: VersionsMap): CandidateReleasePullRequest[];
     protected buildGraph(allPackages: CrateInfo[]): Promise<DependencyGraph<CrateInfo>>;
     protected inScope(candidate: CandidateReleasePullRequest): boolean;
     protected packageNameFromPackage(pkg: CrateInfo): string;

package/build/src/plugins/cargo-workspace.js

@@ -113,10 +113,7 @@ class CargoWorkspace extends workspace_1.WorkspacePlugin {
                     update.updater.changelogEntry = appendDependenciesSectionToChangelog(update.updater.changelogEntry, dependencyNotes);
                 }
                 else if (update.path === addPath(existingCandidate.path, 'Cargo.lock')) {
-                    update.updater = new cargo_lock_1.CargoLock({
-                        version,
-                        versionsMap: updatedVersions,
-                    });
+                    update.updater = new cargo_lock_1.CargoLock(updatedVersions);
                 }
                 return update;
             });
@@ -186,6 +183,18 @@ class CargoWorkspace extends workspace_1.WorkspacePlugin {
             },
         };
     }
+    postProcessCandidates(candidates, updatedVersions) {
+        const rootCandidate = candidates.find(c => c.path === manifest_1.ROOT_PROJECT_PATH);
+        if (!rootCandidate) {
+            throw Error('Unable to find root candidate pull request');
+        }
+        rootCandidate.pullRequest.updates.push({
+            path: 'Cargo.lock',
+            createIfMissing: false,
+            updater: new cargo_lock_1.CargoLock(updatedVersions),
+        });
+        return candidates;
+    }
     async buildGraph(allPackages) {
         var _a, _b, _c;
         const workspaceCrateNames = new Set(allPackages.map(crateInfo => crateInfo.name));

package/build/src/plugins/merge.js

@@ -20,6 +20,7 @@ const pull_request_title_1 = require("../util/pull-request-title");
 const pull_request_body_1 = require("../util/pull-request-body");
 const branch_name_1 = require("../util/branch-name");
 const composite_1 = require("../updaters/composite");
+const logger_1 = require("../util/logger");
 /**
  * This plugin merges multiple pull requests into a single
  * release pull request.
@@ -36,6 +37,7 @@ class Merge extends plugin_1.ManifestPlugin {
         if (candidates.length < 1) {
             return candidates;
         }
+        logger_1.logger.info(`Merging ${candidates.length} pull requests`);
         const releaseData = [];
         const labels = new Set();
         let rawUpdates = [];
@@ -54,7 +56,7 @@ class Merge extends plugin_1.ManifestPlugin {
         const updates = composite_1.mergeUpdates(rawUpdates);
         const pullRequest = {
             title: pull_request_title_1.PullRequestTitle.ofComponentTargetBranchVersion(rootRelease === null || rootRelease === void 0 ? void 0 : rootRelease.pullRequest.title.component, this.targetBranch, rootRelease === null || rootRelease === void 0 ? void 0 : rootRelease.pullRequest.title.version, this.pullRequestTitlePattern),
-            body: new pull_request_body_1.PullRequestBody(releaseData),
+            body: new pull_request_body_1.PullRequestBody(releaseData, { useComponents: true }),
             updates,
             labels: Array.from(labels),
             headRefName: branch_name_1.BranchName.ofTargetBranch(this.targetBranch).toString(),

package/build/src/plugins/node-workspace.d.ts

@@ -29,6 +29,7 @@ export declare class NodeWorkspace extends WorkspacePlugin<Package> {
     protected bumpVersion(pkg: Package): Version;
     protected updateCandidate(existingCandidate: CandidateReleasePullRequest, pkg: Package, updatedVersions: VersionsMap): CandidateReleasePullRequest;
     protected newCandidate(pkg: Package, updatedVersions: VersionsMap): CandidateReleasePullRequest;
+    protected postProcessCandidates(candidates: CandidateReleasePullRequest[], _updatedVersions: VersionsMap): CandidateReleasePullRequest[];
     protected buildGraph(allPackages: Package[]): Promise<DependencyGraph<Package>>;
     protected inScope(candidate: CandidateReleasePullRequest): boolean;
     protected packageNameFromPackage(pkg: Package): string;

package/build/src/plugins/node-workspace.js

@@ -190,6 +190,10 @@ class NodeWorkspace extends workspace_1.WorkspacePlugin {
             },
         };
     }
+    postProcessCandidates(candidates, _updatedVersions) {
+        // NOP for node workspaces
+        return candidates;
+    }
     async buildGraph(allPackages) {
         var _a, _b, _c, _d;
         const graph = new Map();

package/build/src/plugins/workspace.d.ts

@@ -83,6 +83,19 @@ export declare abstract class WorkspacePlugin<T> extends ManifestPlugin {
      * @returns {string} The package name.
      */
     protected abstract packageNameFromPackage(pkg: T): string;
+    /**
+     * Amend any or all in-scope candidates once all other processing has occured.
+     *
+     * This gives the workspace plugin once last chance to tweak the pull-requests
+     * once all the underlying information has been collated.
+     * @param {CandidateReleasePullRequest[]} candidates - The list of candidates
+     *   once all other workspace processing has occured.
+     * @param {VersionMap} updatedVersions - Map containing any component versions
+     *   that have changed.
+     * @returns {CandidateReleasePullRequest[]} potentially amended list of
+     *   candidates.
+     */
+    protected abstract postProcessCandidates(candidates: CandidateReleasePullRequest[], updatedVersions: VersionsMap): CandidateReleasePullRequest[];
     /**
      * Helper to invert the graph from package => packages that it depends on
      * to package => packages that depend on it.

package/build/src/plugins/workspace.js

@@ -98,6 +98,8 @@ class WorkspacePlugin extends plugin_1.ManifestPlugin {
         logger_1.logger.info(`Merging ${newCandidates.length} in-scope candidates`);
         const mergePlugin = new merge_1.Merge(this.github, this.targetBranch, this.repositoryConfig);
         newCandidates = await mergePlugin.run(newCandidates);
+        logger_1.logger.info(`Post-processing ${newCandidates.length} in-scope candidates`);
+        newCandidates = this.postProcessCandidates(newCandidates, updatedVersions);
         return [...outOfScopeCandidates, ...newCandidates];
     }
     /**

package/build/src/strategies/base.d.ts

@@ -110,5 +110,11 @@ export declare abstract class BaseStrategy implements Strategy {
      * Override this to handle the initial version of a new library.
      */
     protected initialReleaseVersion(): Version;
+    /**
+     * Adds a given file path to the strategy path.
+     * @param {string} file Desired file path.
+     * @returns {string} The file relative to the strategy.
+     * @throws {Error} If the file path contains relative pathing characters, i.e. ../, ~/
+     */
     protected addPath(file: string): string;
 }

package/build/src/strategies/base.js

@@ -65,7 +65,8 @@ class BaseStrategy {
         return this.component || (await this.getDefaultComponent());
     }
     async getDefaultComponent() {
-        return this.normalizeComponent(await this.getDefaultPackageName());
+        var _a;
+        return this.normalizeComponent((_a = this.packageName) !== null && _a !== void 0 ? _a : (await this.getDefaultPackageName()));
     }
     async getDefaultPackageName() {
         return '';
@@ -117,10 +118,17 @@ class BaseStrategy {
      *   open a pull request.
      */
     async buildReleasePullRequest(commits, latestRelease, draft, labels = []) {
+        var _a;
         const conventionalCommits = await this.postProcessCommits(commit_1.parseConventionalCommits(commits));
         logger_1.logger.info(`Considering: ${conventionalCommits.length} commits`);
+        if (conventionalCommits.length === 0) {
+            logger_1.logger.info(`No commits for path: ${this.path}, skipping`);
+            return undefined;
+        }
         const newVersion = await this.buildNewVersion(conventionalCommits, latestRelease);
         const versionsMap = await this.updateVersionsMap(await this.buildVersionsMap(conventionalCommits), conventionalCommits);
+        this.packageName = (_a = this.packageName) !== null && _a !== void 0 ? _a : (await this.getDefaultPackageName());
+        logger_1.logger.debug('packageName', this.packageName);
         const component = await this.getComponent();
         logger_1.logger.debug('component:', component);
         const newVersionTag = new tag_name_1.TagName(newVersion, this.includeComponentInTag ? component : undefined, this.tagSeparator);
@@ -154,13 +162,11 @@ class BaseStrategy {
     }
     extraFileUpdates(version) {
         const genericUpdater = new generic_1.Generic({ version });
-        return this.extraFiles.map(path => {
-            return {
-                path,
-                createIfMissing: false,
-                updater: genericUpdater,
-            };
-        });
+        return this.extraFiles.map(path => ({
+            path: this.addPath(path),
+            createIfMissing: false,
+            updater: genericUpdater,
+        }));
     }
     changelogEmpty(changelogEntry) {
         return changelogEntry.split('\n').length <= 1;
@@ -265,18 +271,28 @@ class BaseStrategy {
     initialReleaseVersion() {
         return version_1.Version.parse('1.0.0');
     }
+    /**
+     * Adds a given file path to the strategy path.
+     * @param {string} file Desired file path.
+     * @returns {string} The file relative to the strategy.
+     * @throws {Error} If the file path contains relative pathing characters, i.e. ../, ~/
+     */
     addPath(file) {
-        if (this.path === manifest_1.ROOT_PROJECT_PATH) {
-            return file;
-        }
-        file = file.replace(/^[/\\]/, '');
-        if (this.path === undefined) {
-            return file;
+        // There is no strategy path to join, the strategy is at the root, or the
+        // file is at the root (denoted by a leading slash or tilde)
+        if (!this.path || this.path === manifest_1.ROOT_PROJECT_PATH || file.startsWith('/')) {
+            file = file.replace(/^\/+/, '');
         }
+        // Otherwise, the file is relative to the strategy path
         else {
-            const path = this.path.replace(/[/\\]$/, '');
-            return `${path}/${file}`;
+            file = `${this.path.replace(/\/+$/, '')}/${file}`;
+        }
+        // Ensure the file path does not escape the workspace
+        if (/((^|\/)\.{1,2}|^~|^\/*)+\//.test(file)) {
+            throw new Error(`illegal pathing characters in path: ${file}`);
         }
+        // Strip any trailing slashes and return
+        return file.replace(/\/+$/, '');
     }
 }
 exports.BaseStrategy = BaseStrategy;

package/build/src/strategies/java-yoshi.d.ts

@@ -14,6 +14,12 @@ export declare class JavaYoshi extends BaseStrategy {
     constructor(options: BaseStrategyOptions);
     buildReleasePullRequest(commits: Commit[], latestRelease?: Release, draft?: boolean, labels?: string[]): Promise<ReleasePullRequest | undefined>;
     private buildSnapshotPullRequest;
+    /**
+     * Override this method to post process commits
+     * @param {ConventionalCommit[]} commits parsed commits
+     * @returns {ConventionalCommit[]} modified commits
+     */
+    protected postProcessCommits(commits: ConventionalCommit[]): Promise<ConventionalCommit[]>;
     private needsSnapshot;
     protected buildVersionsMap(): Promise<VersionsMap>;
     protected getVersionsContent(): Promise<GitHubFileContents>;

package/build/src/strategies/java-yoshi.js

@@ -102,6 +102,29 @@ class JavaYoshi extends base_1.BaseStrategy {
             draft: false,
         };
     }
+    /**
+     * Override this method to post process commits
+     * @param {ConventionalCommit[]} commits parsed commits
+     * @returns {ConventionalCommit[]} modified commits
+     */
+    async postProcessCommits(commits) {
+        if (commits.length === 0) {
+            // For Java commits, push a fake commit so we force a
+            // SNAPSHOT release
+            commits.push({
+                type: 'fake',
+                bareMessage: 'fake commit',
+                message: 'fake commit',
+                breaking: false,
+                scope: null,
+                notes: [],
+                files: [],
+                references: [],
+                sha: 'fake',
+            });
+        }
+        return commits;
+    }
     async needsSnapshot() {
         return versions_manifest_1.VersionsManifest.needsSnapshot((await this.getVersionsContent()).parsedContent);
     }

package/build/src/strategies/node.js

@@ -23,7 +23,7 @@ class Node extends base_1.BaseStrategy {
     async buildUpdates(options) {
         const updates = [];
         const version = options.newVersion;
-        const packageName = this.component || '';
+        const packageName = this.packageName || '';
         const lockFiles = ['package-lock.json', 'npm-shrinkwrap.json'];
         lockFiles.forEach(lockFile => {
             updates.push({

package/build/src/strategies/php-yoshi.d.ts

@@ -6,7 +6,7 @@ import { ReleasePullRequest } from '../release-pull-request';
 import { PullRequestBody } from '../util/pull-request-body';
 export declare class PHPYoshi extends BaseStrategy {
     constructor(options: BaseStrategyOptions);
-    buildReleasePullRequest(commits: Commit[], latestRelease?: Release, draft?: boolean, labels?: string[]): Promise<ReleasePullRequest>;
+    buildReleasePullRequest(commits: Commit[], latestRelease?: Release, draft?: boolean, labels?: string[]): Promise<ReleasePullRequest | undefined>;
     protected parsePullRequestBody(pullRequestBody: string): Promise<PullRequestBody | undefined>;
     protected buildUpdates(options: BuildUpdatesOptions): Promise<Update[]>;
 }

package/build/src/strategies/php-yoshi.js

@@ -51,6 +51,10 @@ class PHPYoshi extends base_1.BaseStrategy {
     async buildReleasePullRequest(commits, latestRelease, draft, labels = []) {
         var _a, _b, _c;
         const conventionalCommits = await this.postProcessCommits(commit_1.parseConventionalCommits(commits));
+        if (conventionalCommits.length === 0) {
+            logger_1.logger.info(`No commits for path: ${this.path}, skipping`);
+            return undefined;
+        }
         const newVersion = latestRelease
             ? await this.versioningStrategy.bump(latestRelease.tag.version, conventionalCommits)
             : this.initialReleaseVersion();

package/build/src/strategies/rust.js

@@ -102,10 +102,7 @@ class Rust extends base_1.BaseStrategy {
         updates.push({
             path: this.addPath('Cargo.lock'),
             createIfMissing: false,
-            updater: new cargo_lock_1.CargoLock({
-                version,
-                versionsMap,
-            }),
+            updater: new cargo_lock_1.CargoLock(versionsMap),
         });
         return updates;
     }

package/build/src/updaters/krm/krm-blueprint-version.js

@@ -32,7 +32,7 @@ class KRMBlueprintVersion extends default_1.DefaultUpdater {
         let matchRegex = '(cnrm/.*/)(v[0-9]+.[0-9]+.[0-9]+)+(-w+)?';
         // if explicit previous version, match only that version
         if ((_a = this.versionsMap) === null || _a === void 0 ? void 0 : _a.has('previousVersion')) {
-            matchRegex = `(cnrm/.*/)(${this.versionsMap.get('previousVersion')})+(-w+)?`;
+            matchRegex = `(cnrm/.*/)(v${this.versionsMap.get('previousVersion')})+(-w+)?`;
         }
         const oldVersion = content.match(new RegExp(matchRegex));
         if (oldVersion) {

package/build/src/updaters/rust/cargo-lock.d.ts

@@ -1,8 +1,11 @@
-import { DefaultUpdater } from '../default';
+import { Updater } from '../../update';
+import { VersionsMap } from '../../version';
 /**
  * Updates `Cargo.lock` lockfiles, preserving formatting and comments.
  */
-export declare class CargoLock extends DefaultUpdater {
+export declare class CargoLock implements Updater {
+    versionsMap: VersionsMap;
+    constructor(versionsMap: VersionsMap);
     /**
      * Given initial file contents, return updated contents.
      * @param {string} content The initial content

package/build/src/updaters/rust/cargo-lock.js

@@ -17,11 +17,13 @@ exports.CargoLock = void 0;
 const toml_edit_1 = require("../../util/toml-edit");
 const common_1 = require("./common");
 const logger_1 = require("../../util/logger");
-const default_1 = require("../default");
 /**
  * Updates `Cargo.lock` lockfiles, preserving formatting and comments.
  */
-class CargoLock extends default_1.DefaultUpdater {
+class CargoLock {
+    constructor(versionsMap) {
+        this.versionsMap = versionsMap;
+    }
     /**
      * Given initial file contents, return updated contents.
      * @param {string} content The initial content
@@ -29,9 +31,6 @@ class CargoLock extends default_1.DefaultUpdater {
      */
     updateContent(content) {
         let payload = content;
-        if (!this.versionsMap) {
-            throw new Error('updateContent called with no versions');
-        }
         const parsed = common_1.parseCargoLockfile(payload);
         if (!parsed.package) {
             logger_1.logger.error('is not a Cargo lockfile');

package/build/src/util/pull-request-body.d.ts

@@ -3,12 +3,14 @@ interface PullRequestBodyOptions {
     header?: string;
     footer?: string;
     extra?: string;
+    useComponents?: boolean;
 }
 export declare class PullRequestBody {
     header: string;
     footer: string;
     extra?: string;
     releaseData: ReleaseData[];
+    useComponents: boolean;
     constructor(releaseData: ReleaseData[], options?: PullRequestBodyOptions);
     static parse(body: string): PullRequestBody | undefined;
     notes(): string;

package/build/src/util/pull-request-body.js

@@ -22,10 +22,12 @@ const DEFAULT_FOOTER = 'This PR was generated with [Release Please](https://gith
 const NOTES_DELIMITER = '---';
 class PullRequestBody {
     constructor(releaseData, options) {
+        var _a;
         this.header = (options === null || options === void 0 ? void 0 : options.header) || DEFAULT_HEADER;
         this.footer = (options === null || options === void 0 ? void 0 : options.footer) || DEFAULT_FOOTER;
         this.extra = options === null || options === void 0 ? void 0 : options.extra;
         this.releaseData = releaseData;
+        this.useComponents = (_a = options === null || options === void 0 ? void 0 : options.useComponents) !== null && _a !== void 0 ? _a : this.releaseData.length > 1;
     }
     static parse(body) {
         const parts = splitBody(body);
@@ -46,7 +48,7 @@ class PullRequestBody {
         });
     }
     notes() {
-        if (this.releaseData.length > 1) {
+        if (this.useComponents) {
             return this.releaseData
                 .map(release => {
                 var _a;
@@ -110,7 +112,7 @@ function extractMultipleReleases(notes) {
     }
     return data;
 }
-const COMPARE_REGEX = /^#{2,} \[(?<version>\d+\.\d+\.\d+.*)\]/;
+const COMPARE_REGEX = /^#{2,} \[?(?<version>\d+\.\d+\.\d+.*)\]?/;
 function extractSingleRelease(body) {
     var _a;
     body = body.trim();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "release-please",
-  "version": "13.4.2",
+  "version": "13.4.6",
   "description": "generate release PRs based on the conventionalcommits.org spec",
   "main": "./build/src/index.js",
   "bin": "./build/src/bin/release-please.js",
@@ -53,7 +53,7 @@
     "gts": "^3.0.0",
     "mocha": "^9.0.0",
     "nock": "^13.0.0",
-    "sinon": "12.0.1",
+    "sinon": "13.0.0",
     "snap-shot-it": "^7.0.0"
   },
   "dependencies": {