release-please 14.4.0 → 14.5.0

package/CHANGELOG.md

@@ -4,6 +4,13 @@
 
 [1]: https://www.npmjs.com/package/release-please?activeTab=versions
 
+## [14.5.0](https://github.com/googleapis/release-please/compare/v14.4.0...v14.5.0) (2022-09-07)
+
+
+### Features
+
+* Allow specifying glob option for extra-files ([#1621](https://github.com/googleapis/release-please/issues/1621)) ([d0fbd90](https://github.com/googleapis/release-please/commit/d0fbd90659f14b975ba56570712b8a4b1ed59e25)), closes [#1619](https://github.com/googleapis/release-please/issues/1619)
+
 ## [14.4.0](https://github.com/googleapis/release-please/compare/v14.3.1...v14.4.0) (2022-09-07)
 
 

package/build/src/github.d.ts

@@ -248,6 +248,30 @@ export declare class GitHub {
      * @throws {GitHubAPIError} on an API error
      */
     findFilesByFilenameAndRef: (filename: string, ref: string, prefix?: string | undefined) => Promise<string[]>;
+    /**
+     * Returns a list of paths to all files matching a glob pattern.
+     *
+     * If a prefix is specified, only return paths that match
+     * the provided prefix.
+     *
+     * @param glob The glob to match
+     * @param prefix Optional path prefix used to filter results
+     * @returns {string[]} List of file paths
+     * @throws {GitHubAPIError} on an API error
+     */
+    findFilesByGlob(glob: string, prefix?: string): Promise<string[]>;
+    /**
+     * Returns a list of paths to all files matching a glob pattern.
+     *
+     * If a prefix is specified, only return paths that match
+     * the provided prefix.
+     *
+     * @param glob The glob to match
+     * @param ref Git reference to search files in
+     * @param prefix Optional path prefix used to filter results
+     * @throws {GitHubAPIError} on an API error
+     */
+    findFilesByGlobAndRef: (glob: string, ref: string, prefix?: string | undefined) => Promise<string[]>;
     /**
      * Open a pull request
      *

package/build/src/github.js

@@ -110,6 +110,24 @@ class GitHub {
             this.logger.debug(`finding files by filename: ${filename}, ref: ${ref}, prefix: ${prefix}`);
             return await this.fileCache.findFilesByFilename(filename, ref, prefix);
         });
+        /**
+         * Returns a list of paths to all files matching a glob pattern.
+         *
+         * If a prefix is specified, only return paths that match
+         * the provided prefix.
+         *
+         * @param glob The glob to match
+         * @param ref Git reference to search files in
+         * @param prefix Optional path prefix used to filter results
+         * @throws {GitHubAPIError} on an API error
+         */
+        this.findFilesByGlobAndRef = wrapAsync(async (glob, ref, prefix) => {
+            if (prefix) {
+                prefix = normalizePrefix(prefix);
+            }
+            this.logger.debug(`finding files by glob: ${glob}, ref: ${ref}, prefix: ${prefix}`);
+            return await this.fileCache.findFilesByGlob(glob, ref, prefix);
+        });
         this.createPullRequest = wrapAsync(async (pullRequest, targetBranch, message, updates, options) => {
             //  Update the files for the release if not already supplied
             const changes = await this.buildChangeSet(updates, targetBranch);
@@ -903,6 +921,20 @@ class GitHub {
     async findFilesByFilename(filename, prefix) {
         return this.findFilesByFilenameAndRef(filename, this.repository.defaultBranch, prefix);
     }
+    /**
+     * Returns a list of paths to all files matching a glob pattern.
+     *
+     * If a prefix is specified, only return paths that match
+     * the provided prefix.
+     *
+     * @param glob The glob to match
+     * @param prefix Optional path prefix used to filter results
+     * @returns {string[]} List of file paths
+     * @throws {GitHubAPIError} on an API error
+     */
+    async findFilesByGlob(glob, prefix) {
+        return this.findFilesByGlobAndRef(glob, this.repository.defaultBranch, prefix);
+    }
     /**
      * Open a pull request
      *

package/build/src/manifest.d.ts

@@ -10,20 +10,24 @@ declare type ExtraJsonFile = {
     type: 'json';
     path: string;
     jsonpath: string;
+    glob?: boolean;
 };
 declare type ExtraYamlFile = {
     type: 'yaml';
     path: string;
     jsonpath: string;
+    glob?: boolean;
 };
 declare type ExtraXmlFile = {
     type: 'xml';
     path: string;
     xpath: string;
+    glob?: boolean;
 };
 declare type ExtraPomFile = {
     type: 'pom';
     path: string;
+    glob?: boolean;
 };
 export declare type ExtraFile = string | ExtraJsonFile | ExtraYamlFile | ExtraXmlFile | ExtraPomFile;
 /**

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

@@ -109,7 +109,8 @@ export declare abstract class BaseStrategy implements Strategy {
      *   open a pull request.
      */
     buildReleasePullRequest(commits: Commit[], latestRelease?: Release, draft?: boolean, labels?: string[]): Promise<ReleasePullRequest | undefined>;
-    protected extraFileUpdates(version: Version, versionsMap: VersionsMap): Update[];
+    private extraFilePaths;
+    protected extraFileUpdates(version: Version, versionsMap: VersionsMap): Promise<Update[]>;
     protected changelogEmpty(changelogEntry: string): boolean;
     protected updateVersionsMap(versionsMap: VersionsMap, conventionalCommits: ConventionalCommit[], _newVersion: Version): Promise<VersionsMap>;
     protected buildNewVersion(conventionalCommits: ConventionalCommit[], latestRelease?: Release): Promise<Version>;

package/build/src/strategies/base.js

@@ -165,7 +165,7 @@ class BaseStrategy {
             versionsMap,
             latestVersion: latestRelease === null || latestRelease === void 0 ? void 0 : latestRelease.tag.version,
         });
-        const updatesWithExtras = (0, composite_1.mergeUpdates)(updates.concat(...this.extraFileUpdates(newVersion, versionsMap)));
+        const updatesWithExtras = (0, composite_1.mergeUpdates)(updates.concat(...(await this.extraFileUpdates(newVersion, versionsMap))));
         const pullRequestBody = await this.buildPullRequestBody(component, newVersion, releaseNotesBody, conventionalCommits, latestRelease, this.pullRequestHeader);
         return {
             title: pullRequestTitle,
@@ -177,44 +177,77 @@ class BaseStrategy {
             draft: draft !== null && draft !== void 0 ? draft : false,
         };
     }
-    extraFileUpdates(version, versionsMap) {
-        return this.extraFiles.map(extraFile => {
+    // Helper to convert extra files with globs to the file paths to add
+    async extraFilePaths(extraFile) {
+        if (typeof extraFile !== 'object') {
+            return [extraFile];
+        }
+        if (!extraFile.glob) {
+            return [extraFile.path];
+        }
+        if (extraFile.path.startsWith('/')) {
+            // glob is relative to root, strip the leading `/` for glob matching
+            // and re-add the leading `/` to make the file relative to the root
+            return (await this.github.findFilesByGlobAndRef(extraFile.path.slice(1), this.targetBranch)).map(file => `/${file}`);
+        }
+        else if (this.path === manifest_1.ROOT_PROJECT_PATH) {
+            // root component, ignore path prefix
+            return this.github.findFilesByGlobAndRef(extraFile.path, this.targetBranch);
+        }
+        else {
+            // glob is relative to current path
+            return this.github.findFilesByGlobAndRef(extraFile.path, this.targetBranch, this.path);
+        }
+    }
+    async extraFileUpdates(version, versionsMap) {
+        const extraFileUpdates = [];
+        for (const extraFile of this.extraFiles) {
             if (typeof extraFile === 'object') {
-                switch (extraFile.type) {
-                    case 'json':
-                        return {
-                            path: this.addPath(extraFile.path),
-                            createIfMissing: false,
-                            updater: new generic_json_1.GenericJson(extraFile.jsonpath, version),
-                        };
-                    case 'yaml':
-                        return {
-                            path: this.addPath(extraFile.path),
-                            createIfMissing: false,
-                            updater: new generic_yaml_1.GenericYaml(extraFile.jsonpath, version),
-                        };
-                    case 'xml':
-                        return {
-                            path: this.addPath(extraFile.path),
-                            createIfMissing: false,
-                            updater: new generic_xml_1.GenericXml(extraFile.xpath, version),
-                        };
-                    case 'pom':
-                        return {
-                            path: this.addPath(extraFile.path),
-                            createIfMissing: false,
-                            updater: new pom_xml_1.PomXml(version),
-                        };
-                    default:
-                        throw new Error(`unsupported extraFile type: ${extraFile.type}`);
+                const paths = await this.extraFilePaths(extraFile);
+                for (const path of paths) {
+                    switch (extraFile.type) {
+                        case 'json':
+                            extraFileUpdates.push({
+                                path: this.addPath(path),
+                                createIfMissing: false,
+                                updater: new generic_json_1.GenericJson(extraFile.jsonpath, version),
+                            });
+                            break;
+                        case 'yaml':
+                            extraFileUpdates.push({
+                                path: this.addPath(path),
+                                createIfMissing: false,
+                                updater: new generic_yaml_1.GenericYaml(extraFile.jsonpath, version),
+                            });
+                            break;
+                        case 'xml':
+                            extraFileUpdates.push({
+                                path: this.addPath(path),
+                                createIfMissing: false,
+                                updater: new generic_xml_1.GenericXml(extraFile.xpath, version),
+                            });
+                            break;
+                        case 'pom':
+                            extraFileUpdates.push({
+                                path: this.addPath(path),
+                                createIfMissing: false,
+                                updater: new pom_xml_1.PomXml(version),
+                            });
+                            break;
+                        default:
+                            throw new Error(`unsupported extraFile type: ${extraFile.type}`);
+                    }
                 }
             }
-            return {
-                path: this.addPath(extraFile),
-                createIfMissing: false,
-                updater: new generic_1.Generic({ version, versionsMap }),
-            };
-        });
+            else {
+                extraFileUpdates.push({
+                    path: this.addPath(extraFile),
+                    createIfMissing: false,
+                    updater: new generic_1.Generic({ version, versionsMap }),
+                });
+            }
+        }
+        return extraFileUpdates;
     }
     changelogEmpty(changelogEntry) {
         return changelogEntry.split('\n').length <= 1;

package/build/src/strategies/java.js

@@ -94,7 +94,7 @@ class Java extends base_1.BaseStrategy {
             changelogEntry: notes,
             isSnapshot: true,
         });
-        const updatesWithExtras = (0, composite_1.mergeUpdates)(updates.concat(...this.extraFileUpdates(newVersion, versionsMap)));
+        const updatesWithExtras = (0, composite_1.mergeUpdates)(updates.concat(...(await this.extraFileUpdates(newVersion, versionsMap))));
         return {
             title: pullRequestTitle,
             body: pullRequestBody,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "release-please",
-  "version": "14.4.0",
+  "version": "14.5.0",
   "description": "generate release PRs based on the conventionalcommits.org spec",
   "main": "./build/src/index.js",
   "bin": "./build/src/bin/release-please.js",
@@ -68,7 +68,7 @@
   },
   "dependencies": {
     "@conventional-commits/parser": "^0.4.1",
-    "@google-automations/git-file-utils": "^1.1.0",
+    "@google-automations/git-file-utils": "^1.2.0",
     "@iarna/toml": "^2.2.5",
     "@lerna/collect-updates": "^4.0.0",
     "@lerna/package": "^4.0.0",

package/schemas/config.json

@@ -132,6 +132,10 @@
                     "description": "The path to the file.",
                     "type": "string"
                   },
+                  "glob": {
+                    "description": "Whether to treat the path as a glob. Defaults to `false`.",
+                    "type": "boolean"
+                  },
                   "jsonpath": {
                     "description": "The jsonpath to the version entry in the file.",
                     "type": "string"
@@ -151,6 +155,10 @@
                     "description": "The path to the file.",
                     "type": "string"
                   },
+                  "glob": {
+                    "description": "Whether to treat the path as a glob. Defaults to `false`.",
+                    "type": "boolean"
+                  },
                   "xpath": {
                     "description": "The xpath to the version entry in the file.",
                     "type": "string"
@@ -169,6 +177,10 @@
                   "path": {
                     "description": "The path to the file.",
                     "type": "string"
+                  },
+                  "glob": {
+                    "description": "Whether to treat the path as a glob. Defaults to `false`.",
+                    "type": "boolean"
                   }
                 },
                 "required": ["type", "path"]