release-please 13.3.2 → 13.4.0

package/CHANGELOG.md

@@ -4,6 +4,19 @@
 
 [1]: https://www.npmjs.com/package/release-please?activeTab=versions
 
+## [13.4.0](https://github.com/googleapis/release-please/compare/v13.3.2...v13.4.0) (2022-01-18)
+
+
+### Features
+
+* add grouped manifest pr title pattern option ([#1184](https://github.com/googleapis/release-please/issues/1184)) ([df1332f](https://github.com/googleapis/release-please/commit/df1332f3b95e622752d351a29fc0a1b5083963c6))
+
+
+### Bug Fixes
+
+* **go-yoshi:** restore scope-based commit filtering ([#1233](https://github.com/googleapis/release-please/issues/1233)) ([597e6dd](https://github.com/googleapis/release-please/commit/597e6dd58217c62d562070032138cee8cad5e693))
+* search for files on target branch, not default branch ([#1235](https://github.com/googleapis/release-please/issues/1235)) ([d891f00](https://github.com/googleapis/release-please/commit/d891f000eb2b198bfb4331b41bc5020fff52e1da))
+
 ### [13.3.2](https://github.com/googleapis/release-please/compare/v13.3.1...v13.3.2) (2022-01-13)
 
 

package/build/src/manifest.d.ts

@@ -71,6 +71,7 @@ export interface ManifestOptions {
     draft?: boolean;
     prerelease?: boolean;
     draftPullRequest?: boolean;
+    groupPullRequestTitlePattern?: string;
 }
 interface ReleaserPackageConfig extends ReleaserConfigJson {
     'package-name'?: string;
@@ -88,6 +89,7 @@ export interface ManifestConfig extends ReleaserConfigJson {
     'always-link-local'?: boolean;
     plugins?: PluginType[];
     'separate-pull-requests'?: boolean;
+    'group-pull-request-title-pattern'?: string;
 }
 export declare type ReleasedVersions = Record<string, Version>;
 export declare type RepositoryConfig = Record<string, ReleaserConfig>;
@@ -122,6 +124,7 @@ export declare class Manifest {
     private draft?;
     private prerelease?;
     private draftPullRequest?;
+    private groupPullRequestTitlePattern?;
     /**
      * Create a Manifest from explicit config in code. This assumes that the
      * repository has a single component at the root path.

package/build/src/manifest.js

@@ -77,6 +77,7 @@ class Manifest {
         this.lastReleaseSha = manifestOptions === null || manifestOptions === void 0 ? void 0 : manifestOptions.lastReleaseSha;
         this.draft = manifestOptions === null || manifestOptions === void 0 ? void 0 : manifestOptions.draft;
         this.draftPullRequest = manifestOptions === null || manifestOptions === void 0 ? void 0 : manifestOptions.draftPullRequest;
+        this.groupPullRequestTitlePattern = manifestOptions === null || manifestOptions === void 0 ? void 0 : manifestOptions.groupPullRequestTitlePattern;
     }
     /**
      * Create a Manifest from config files in the repository.
@@ -314,7 +315,7 @@ class Manifest {
         // Combine pull requests into 1 unless configured for separate
         // pull requests
         if (!this.separatePullRequests) {
-            plugins.push(new merge_1.Merge(this.github, this.targetBranch, this.repositoryConfig));
+            plugins.push(new merge_1.Merge(this.github, this.targetBranch, this.repositoryConfig, this.groupPullRequestTitlePattern));
         }
         for (const plugin of plugins) {
             newReleasePullRequests = await plugin.run(newReleasePullRequests);
@@ -588,6 +589,7 @@ async function parseConfig(github, configFile, branch) {
         lastReleaseSha: config['last-release-sha'],
         alwaysLinkLocal: config['always-link-local'],
         separatePullRequests: config['separate-pull-requests'],
+        groupPullRequestTitlePattern: config['group-pull-request-title-pattern'],
         plugins: config['plugins'],
     };
     return { config: repositoryConfig, options: manifestOptions };
@@ -701,7 +703,7 @@ async function latestReleaseVersion(github, targetBranch, prefix, pullRequestTit
     return candidateTagVersion.sort((a, b) => b.compare(a))[0];
 }
 function mergeReleaserConfig(defaultConfig, pathConfig) {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q;
     return {
         releaseType: (_b = (_a = pathConfig.releaseType) !== null && _a !== void 0 ? _a : defaultConfig.releaseType) !== null && _b !== void 0 ? _b : 'node',
         bumpMinorPreMajor: (_c = pathConfig.bumpMinorPreMajor) !== null && _c !== void 0 ? _c : defaultConfig.bumpMinorPreMajor,
@@ -716,6 +718,7 @@ function mergeReleaserConfig(defaultConfig, pathConfig) {
         packageName: (_m = pathConfig.packageName) !== null && _m !== void 0 ? _m : defaultConfig.packageName,
         versionFile: (_o = pathConfig.versionFile) !== null && _o !== void 0 ? _o : defaultConfig.versionFile,
         extraFiles: (_p = pathConfig.extraFiles) !== null && _p !== void 0 ? _p : defaultConfig.extraFiles,
+        pullRequestTitlePattern: (_q = pathConfig.pullRequestTitlePattern) !== null && _q !== void 0 ? _q : defaultConfig.pullRequestTitlePattern,
     };
 }
 /**

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

@@ -1,5 +1,6 @@
 import { ManifestPlugin } from '../plugin';
-import { CandidateReleasePullRequest } from '../manifest';
+import { CandidateReleasePullRequest, RepositoryConfig } from '../manifest';
+import { GitHub } from '../github';
 /**
  * This plugin merges multiple pull requests into a single
  * release pull request.
@@ -7,5 +8,7 @@ import { CandidateReleasePullRequest } from '../manifest';
  * Release notes are broken up using `<summary>`/`<details>` blocks.
  */
 export declare class Merge extends ManifestPlugin {
+    private pullRequestTitlePattern?;
+    constructor(github: GitHub, targetBranch: string, repositoryConfig: RepositoryConfig, pullRequestTitlePattern?: string);
     run(candidates: CandidateReleasePullRequest[]): Promise<CandidateReleasePullRequest[]>;
 }

package/build/src/plugins/merge.js

@@ -27,6 +27,11 @@ const composite_1 = require("../updaters/composite");
  * Release notes are broken up using `<summary>`/`<details>` blocks.
  */
 class Merge extends plugin_1.ManifestPlugin {
+    constructor(github, targetBranch, repositoryConfig, pullRequestTitlePattern) {
+        super(github, targetBranch, repositoryConfig);
+        this.pullRequestTitlePattern =
+            pullRequestTitlePattern || manifest_1.MANIFEST_PULL_REQUEST_TITLE_PATTERN;
+    }
     async run(candidates) {
         if (candidates.length < 1) {
             return candidates;
@@ -34,6 +39,7 @@ class Merge extends plugin_1.ManifestPlugin {
         const releaseData = [];
         const labels = new Set();
         let rawUpdates = [];
+        let rootRelease = null;
         for (const candidate of candidates) {
             const pullRequest = candidate.pullRequest;
             rawUpdates = rawUpdates.concat(...pullRequest.updates);
@@ -41,10 +47,13 @@ class Merge extends plugin_1.ManifestPlugin {
                 labels.add(label);
             }
             releaseData.push(...pullRequest.body.releaseData);
+            if (candidate.path === '.') {
+                rootRelease = candidate;
+            }
         }
         const updates = composite_1.mergeUpdates(rawUpdates);
         const pullRequest = {
-            title: pull_request_title_1.PullRequestTitle.ofTargetBranch(this.targetBranch, manifest_1.MANIFEST_PULL_REQUEST_TITLE_PATTERN),
+            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),
             updates,
             labels: Array.from(labels),

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

@@ -55,7 +55,7 @@ export declare abstract class BaseStrategy implements Strategy {
     protected tagSeparator?: string;
     private skipGitHubRelease;
     private releaseAs?;
-    private includeComponentInTag;
+    protected includeComponentInTag: boolean;
     private pullRequestTitlePattern?;
     readonly extraFiles: string[];
     readonly changelogNotes: ChangelogNotes;
@@ -79,7 +79,7 @@ export declare abstract class BaseStrategy implements Strategy {
      * @param {ConventionalCommit[]} commits parsed commits
      * @returns {ConventionalCommit[]} modified commits
      */
-    protected postProcessCommits(commits: ConventionalCommit[]): ConventionalCommit[];
+    protected postProcessCommits(commits: ConventionalCommit[]): Promise<ConventionalCommit[]>;
     protected buildReleaseNotes(conventionalCommits: ConventionalCommit[], newVersion: Version, newVersionTag: TagName, latestRelease?: Release): Promise<string>;
     protected buildPullRequestBody(component: string | undefined, newVersion: Version, releaseNotesBody: string, _conventionalCommits: ConventionalCommit[], _latestRelease?: Release): Promise<PullRequestBody>;
     /**

package/build/src/strategies/base.js

@@ -81,7 +81,7 @@ class BaseStrategy {
      * @param {ConventionalCommit[]} commits parsed commits
      * @returns {ConventionalCommit[]} modified commits
      */
-    postProcessCommits(commits) {
+    async postProcessCommits(commits) {
         return commits;
     }
     async buildReleaseNotes(conventionalCommits, newVersion, newVersionTag, latestRelease) {
@@ -117,13 +117,14 @@ class BaseStrategy {
      *   open a pull request.
      */
     async buildReleasePullRequest(commits, latestRelease, draft, labels = []) {
-        const conventionalCommits = this.postProcessCommits(commit_1.parseConventionalCommits(commits));
+        const conventionalCommits = await this.postProcessCommits(commit_1.parseConventionalCommits(commits));
+        logger_1.logger.info(`Considering: ${conventionalCommits.length} commits`);
         const newVersion = await this.buildNewVersion(conventionalCommits, latestRelease);
         const versionsMap = await this.updateVersionsMap(await this.buildVersionsMap(conventionalCommits), conventionalCommits);
         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);
-        logger_1.logger.warn('pull request title pattern:', this.pullRequestTitlePattern);
+        logger_1.logger.debug('pull request title pattern:', this.pullRequestTitlePattern);
         const pullRequestTitle = pull_request_title_1.PullRequestTitle.ofComponentTargetBranchVersion(component || '', this.targetBranch, newVersion, this.pullRequestTitlePattern);
         const branchName = component
             ? branch_name_1.BranchName.ofComponentTargetBranch(component, this.targetBranch)

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

@@ -7,7 +7,7 @@ import { Release } from '../release';
 export declare class GoYoshi extends BaseStrategy {
     constructor(options: BaseStrategyOptions);
     protected buildUpdates(options: BuildUpdatesOptions): Promise<Update[]>;
-    protected postProcessCommits(commits: ConventionalCommit[]): ConventionalCommit[];
+    protected postProcessCommits(commits: ConventionalCommit[]): Promise<ConventionalCommit[]>;
     protected buildReleaseNotes(conventionalCommits: ConventionalCommit[], newVersion: Version, newVersionTag: TagName, latestRelease?: Release): Promise<string>;
     protected initialReleaseVersion(): Version;
 }

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

@@ -18,6 +18,7 @@ const base_1 = require("./base");
 const changelog_1 = require("../updaters/changelog");
 const version_1 = require("../version");
 const version_go_1 = require("../updaters/go/version-go");
+const logger_1 = require("../util/logger");
 // Commits containing a scope prefixed with an item in this array will be
 // ignored when generating a release PR for the parent module.
 const IGNORED_SUB_MODULES = new Set([
@@ -59,8 +60,10 @@ class GoYoshi extends base_1.BaseStrategy {
         });
         return updates;
     }
-    postProcessCommits(commits) {
+    async postProcessCommits(commits) {
         let regenCommit;
+        const component = await this.getComponent();
+        logger_1.logger.debug('Filtering commits');
         return commits.filter(commit => {
             var _a, _b;
             // ignore commits whose scope is in the list of ignored modules
@@ -97,6 +100,37 @@ class GoYoshi extends base_1.BaseStrategy {
                     }
                 }
             }
+            // For google-cloud-go, filter into 2 cases, a subset of modules
+            // released independently, and the remainder
+            if (this.repository.owner === 'googleapis' &&
+                this.repository.repo === 'google-cloud-go') {
+                // Skip commits that don't have a scope as we don't know where to
+                // put them
+                if (!commit.scope) {
+                    logger_1.logger.debug(`Skipping commit without scope: ${commit.message}`);
+                    return false;
+                }
+                // Skip commits related to sub-modules as they are not part of
+                // the parent module.
+                if (this.includeComponentInTag) {
+                    // This is a submodule release, so only include commits in this
+                    // scope
+                    if (!commitMatchesScope(commit.scope, component)) {
+                        logger_1.logger.debug(`Skipping commit scope: ${commit.scope} != ${component}`);
+                        return false;
+                    }
+                }
+                else {
+                    // This is the main module release, so ignore sub modules that
+                    // are released independently
+                    for (const submodule of IGNORED_SUB_MODULES) {
+                        if (commitMatchesScope(commit.scope, submodule)) {
+                            logger_1.logger.debug(`Skipping ignored commit scope: ${commit.scope}`);
+                            return false;
+                        }
+                    }
+                }
+            }
             return true;
         });
     }
@@ -111,4 +145,7 @@ class GoYoshi extends base_1.BaseStrategy {
     }
 }
 exports.GoYoshi = GoYoshi;
+function commitMatchesScope(commitScope, scope) {
+    return commitScope === scope || commitScope.startsWith(`${scope}/`);
+}
 //# sourceMappingURL=go-yoshi.js.map

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

@@ -136,9 +136,9 @@ class JavaYoshi extends base_1.BaseStrategy {
                 versionsMap,
             }),
         });
-        const pomFilesSearch = this.github.findFilesByFilename('pom.xml', this.path);
-        const buildFilesSearch = this.github.findFilesByFilename('build.gradle', this.path);
-        const dependenciesSearch = this.github.findFilesByFilename('dependencies.properties', this.path);
+        const pomFilesSearch = this.github.findFilesByFilenameAndRef('pom.xml', this.targetBranch, this.path);
+        const buildFilesSearch = this.github.findFilesByFilenameAndRef('build.gradle', this.targetBranch, this.path);
+        const dependenciesSearch = this.github.findFilesByFilenameAndRef('dependencies.properties', this.targetBranch, this.path);
         const pomFiles = await pomFilesSearch;
         pomFiles.forEach(path => {
             updates.push({

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

@@ -50,7 +50,7 @@ class PHPYoshi extends base_1.BaseStrategy {
     }
     async buildReleasePullRequest(commits, latestRelease, draft, labels = []) {
         var _a, _b, _c;
-        const conventionalCommits = this.postProcessCommits(commit_1.parseConventionalCommits(commits));
+        const conventionalCommits = await this.postProcessCommits(commit_1.parseConventionalCommits(commits));
         const newVersion = latestRelease
             ? await this.versioningStrategy.bump(latestRelease.tag.version, conventionalCommits)
             : this.initialReleaseVersion();

package/build/src/strategies/python.js

@@ -87,7 +87,7 @@ class Python extends base_1.BaseStrategy {
             });
         }
         // There should be only one version.py, but foreach in case that is incorrect
-        const versionPyFilesSearch = this.github.findFilesByFilename('version.py', this.path);
+        const versionPyFilesSearch = this.github.findFilesByFilenameAndRef('version.py', this.targetBranch, this.path);
         const versionPyFiles = await versionPyFilesSearch;
         versionPyFiles.forEach(path => {
             updates.push({

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

@@ -11,7 +11,7 @@ export declare class RubyYoshi extends BaseStrategy {
     readonly versionFile: string;
     constructor(options: RubyYoshiStrategyOptions);
     protected buildUpdates(options: BuildUpdatesOptions): Promise<Update[]>;
-    protected postProcessCommits(commits: ConventionalCommit[]): ConventionalCommit[];
+    protected postProcessCommits(commits: ConventionalCommit[]): Promise<ConventionalCommit[]>;
     protected buildPullRequestBody(component: string | undefined, newVersion: Version, releaseNotesBody: string, conventionalCommits: ConventionalCommit[], latestRelease?: Release): Promise<PullRequestBody>;
 }
 export {};

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

@@ -74,7 +74,7 @@ class RubyYoshi extends base_1.BaseStrategy {
         });
         return updates;
     }
-    postProcessCommits(commits) {
+    async postProcessCommits(commits) {
         commits.forEach(commit => {
             commit.message = indent_commit_1.indentCommit(commit);
         });

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

@@ -8,6 +8,6 @@ export declare class Ruby extends BaseStrategy {
     readonly versionFile: string;
     constructor(options: RubyStrategyOptions);
     protected buildUpdates(options: BuildUpdatesOptions): Promise<Update[]>;
-    protected postProcessCommits(commits: ConventionalCommit[]): ConventionalCommit[];
+    protected postProcessCommits(commits: ConventionalCommit[]): Promise<ConventionalCommit[]>;
 }
 export {};

package/build/src/strategies/ruby.js

@@ -50,7 +50,7 @@ class Ruby extends base_1.BaseStrategy {
         });
         return updates;
     }
-    postProcessCommits(commits) {
+    async postProcessCommits(commits) {
         commits.forEach(commit => {
             commit.message = indent_commit_1.indentCommit(commit);
         });

package/build/src/strategies/terraform-module.js

@@ -35,7 +35,7 @@ class TerraformModule extends base_1.BaseStrategy {
         });
         // Update version in README to current candidate version.
         // A module may have submodules, so find all submodules.
-        const readmeFiles = await this.github.findFilesByFilename('readme.md', this.path);
+        const readmeFiles = await this.github.findFilesByFilenameAndRef('readme.md', this.targetBranch, this.path);
         readmeFiles.forEach(path => {
             updates.push({
                 path: this.addPath(path),
@@ -48,8 +48,8 @@ class TerraformModule extends base_1.BaseStrategy {
         // Update versions.tf to current candidate version.
         // A module may have submodules, so find all versions.tfand versions.tf.tmpl to update.
         const versionFiles = await Promise.all([
-            this.github.findFilesByFilename('versions.tf', this.path),
-            this.github.findFilesByFilename('versions.tf.tmpl', this.path),
+            this.github.findFilesByFilenameAndRef('versions.tf', this.targetBranch, this.path),
+            this.github.findFilesByFilenameAndRef('versions.tf.tmpl', this.targetBranch, this.path),
         ]).then(([v, vt]) => {
             return v.concat(vt);
         });

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

@@ -11,7 +11,7 @@ export declare class PullRequestTitle {
     static ofComponentVersion(component: string, version: Version, pullRequestTitlePattern?: string): PullRequestTitle;
     static ofVersion(version: Version, pullRequestTitlePattern?: string): PullRequestTitle;
     static ofTargetBranchVersion(targetBranch: string, version: Version, pullRequestTitlePattern?: string): PullRequestTitle;
-    static ofComponentTargetBranchVersion(component: string, targetBranch: string, version: Version, pullRequestTitlePattern?: string): PullRequestTitle;
+    static ofComponentTargetBranchVersion(component?: string, targetBranch?: string, version?: Version, pullRequestTitlePattern?: string): PullRequestTitle;
     static ofTargetBranch(targetBranch: string, pullRequestTitlePattern?: string): PullRequestTitle;
     getTargetBranch(): string | undefined;
     getComponent(): string | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "release-please",
-  "version": "13.3.2",
+  "version": "13.4.0",
   "description": "generate release PRs based on the conventionalcommits.org spec",
   "main": "./build/src/index.js",
   "bin": "./build/src/bin/release-please.js",
@@ -79,7 +79,7 @@
     "node-html-parser": "^5.0.0",
     "parse-github-repo-url": "^1.4.1",
     "semver": "^7.0.0",
-    "type-fest": "^1.0.0",
+    "type-fest": "^2.0.0",
     "typescript": "^3.8.3",
     "unist-util-visit": "^2.0.3",
     "unist-util-visit-parents": "^3.1.1",