release-please 13.4.3 → 13.4.4

package/CHANGELOG.md

@@ -4,6 +4,14 @@
 
 [1]: https://www.npmjs.com/package/release-please?activeTab=versions
 
+### [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)
 
 

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) {
@@ -316,7 +312,6 @@ class Manifest {
             targetBranch: this.targetBranch,
             repositoryConfig: this.repositoryConfig,
         }));
-        logger_1.logger.info(`separate pull requests: ${this.separatePullRequests}`);
         // Combine pull requests into 1 unless configured for separate
         // pull requests
         if (!this.separatePullRequests) {

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

@@ -119,6 +119,10 @@ class BaseStrategy {
     async buildReleasePullRequest(commits, latestRelease, draft, labels = []) {
         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);
         const component = await this.getComponent();
@@ -154,13 +158,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 +267,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/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/package.json

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