release-please 15.9.2 → 15.10.0

package/CHANGELOG.md

@@ -4,6 +4,20 @@
 
 [1]: https://www.npmjs.com/package/release-please?activeTab=versions
 
+## [15.10.0](https://github.com/googleapis/release-please/compare/v15.9.3...v15.10.0) (2023-04-10)
+
+
+### Features
+
+* Allow excluding file paths to filter out commits ([#1875](https://github.com/googleapis/release-please/issues/1875)) ([a9bed82](https://github.com/googleapis/release-please/commit/a9bed8232ccaa192fb004953e34c49279d3c779f))
+
+## [15.9.3](https://github.com/googleapis/release-please/compare/v15.9.2...v15.9.3) (2023-04-10)
+
+
+### Bug Fixes
+
+* **python:** Handle large version numbers in setup.cfg ([#1906](https://github.com/googleapis/release-please/issues/1906)) ([9a7b11f](https://github.com/googleapis/release-please/commit/9a7b11f4d0797222fd65e871d4ba9f488a72d1d9))
+
 ## [15.9.2](https://github.com/googleapis/release-please/compare/v15.9.1...v15.9.2) (2023-03-28)
 
 

package/build/src/manifest.d.ts

@@ -70,6 +70,7 @@ export interface ReleaserConfig {
     extraFiles?: ExtraFile[];
     snapshotLabels?: string[];
     skipSnapshot?: boolean;
+    excludePaths?: string[];
 }
 export interface CandidateReleasePullRequest {
     path: string;
@@ -109,6 +110,7 @@ interface ReleaserConfigJson {
     'snapshot-label'?: string;
     'skip-snapshot'?: boolean;
     'initial-version'?: string;
+    'exclude-paths'?: string[];
 }
 export interface ManifestOptions {
     bootstrapSha?: string;

package/build/src/manifest.js

@@ -27,6 +27,7 @@ const release_please_manifest_1 = require("./updaters/release-please-manifest");
 const errors_1 = require("./errors");
 const pull_request_overflow_handler_1 = require("./util/pull-request-overflow-handler");
 const signoff_commit_message_1 = require("./util/signoff-commit-message");
+const commit_exclude_1 = require("./util/commit-exclude");
 exports.DEFAULT_RELEASE_PLEASE_CONFIG = 'release-please-config.json';
 exports.DEFAULT_RELEASE_PLEASE_MANIFEST = '.release-please-manifest.json';
 exports.ROOT_PROJECT_PATH = '.';
@@ -299,10 +300,12 @@ class Manifest {
         });
         const splitCommits = cs.split(commits);
         // limit paths to ones since the last release
-        const commitsPerPath = {};
+        let commitsPerPath = {};
         for (const path in this.repositoryConfig) {
             commitsPerPath[path] = commitsAfterSha(path === exports.ROOT_PROJECT_PATH ? commits : splitCommits[path], releaseShasByPath[path]);
         }
+        const commitExclude = new commit_exclude_1.CommitExclude(this.repositoryConfig);
+        commitsPerPath = commitExclude.excludeCommits(commitsPerPath);
         // backfill latest release tags from manifest
         for (const path in this.repositoryConfig) {
             const latestRelease = releasesByPath[path];
@@ -774,6 +777,7 @@ function extractReleaserConfig(config) {
         extraLabels: (_c = config['extra-label']) === null || _c === void 0 ? void 0 : _c.split(','),
         skipSnapshot: config['skip-snapshot'],
         initialVersion: config['initial-version'],
+        excludePaths: config['exclude-paths'],
     };
 }
 /**
@@ -982,7 +986,7 @@ async function latestReleaseVersion(github, targetBranch, releaseFilter, config,
     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, _q, _r, _s, _t, _u, _v, _w, _x, _y, _z, _0, _1;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y, _z, _0, _1, _2;
     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,
@@ -1009,6 +1013,7 @@ function mergeReleaserConfig(defaultConfig, pathConfig) {
         skipSnapshot: (_z = pathConfig.skipSnapshot) !== null && _z !== void 0 ? _z : defaultConfig.skipSnapshot,
         initialVersion: (_0 = pathConfig.initialVersion) !== null && _0 !== void 0 ? _0 : defaultConfig.initialVersion,
         extraLabels: (_1 = pathConfig.extraLabels) !== null && _1 !== void 0 ? _1 : defaultConfig.extraLabels,
+        excludePaths: (_2 = pathConfig.excludePaths) !== null && _2 !== void 0 ? _2 : defaultConfig.excludePaths,
     };
 }
 /**

package/build/src/updaters/python/setup-cfg.js

@@ -25,7 +25,7 @@ class SetupCfg extends default_1.DefaultUpdater {
      * @returns {string} The updated content
      */
     updateContent(content) {
-        return content.replace(/(version ?= ?)[0-9]+\.[0-9]+\.[0-9](?:-\w+)?/, `$1${this.version}`);
+        return content.replace(/(version ?= ?)[0-9]+\.[0-9]+\.[0-9]+(?:-\w+)?/, `$1${this.version}`);
     }
 }
 exports.SetupCfg = SetupCfg;

package/build/src/util/commit-exclude.d.ts

@@ -0,0 +1,10 @@
+import { Commit } from '../commit';
+import { ReleaserConfig } from '../manifest';
+export type CommitExcludeConfig = Pick<ReleaserConfig, 'excludePaths'>;
+export declare class CommitExclude {
+    private excludePaths;
+    constructor(config: Record<string, CommitExcludeConfig>);
+    excludeCommits<T extends Commit>(commitsPerPath: Record<string, T[]>): Record<string, T[]>;
+    private shouldInclude;
+    private isRelevant;
+}

package/build/src/util/commit-exclude.js

@@ -0,0 +1,49 @@
+"use strict";
+// Copyright 2023 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.CommitExclude = void 0;
+const manifest_1 = require("../manifest");
+const commit_utils_1 = require("./commit-utils");
+class CommitExclude {
+    constructor(config) {
+        this.excludePaths = {};
+        Object.entries(config).forEach(([path, releaseConfig]) => {
+            if (releaseConfig.excludePaths) {
+                this.excludePaths[path] = (0, commit_utils_1.normalizePaths)(releaseConfig.excludePaths);
+            }
+        });
+    }
+    excludeCommits(commitsPerPath) {
+        const filteredCommitsPerPath = {};
+        Object.entries(commitsPerPath).forEach(([path, commits]) => {
+            if (this.excludePaths[path]) {
+                commits = commits.filter(commit => this.shouldInclude(commit, this.excludePaths[path], path));
+            }
+            filteredCommitsPerPath[path] = commits;
+        });
+        return filteredCommitsPerPath;
+    }
+    shouldInclude(commit, excludePaths, packagePath) {
+        return (!commit.files ||
+            !commit.files
+                .filter(file => this.isRelevant(file, packagePath))
+                .every(file => excludePaths.some(path => this.isRelevant(file, path))));
+    }
+    isRelevant(file, path) {
+        return path === manifest_1.ROOT_PROJECT_PATH || file.indexOf(`${path}/`) === 0;
+    }
+}
+exports.CommitExclude = CommitExclude;
+//# sourceMappingURL=commit-exclude.js.map

package/build/src/util/commit-split.js

@@ -15,6 +15,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CommitSplit = void 0;
 const manifest_1 = require("../manifest");
+const commit_utils_1 = require("./commit-utils");
 /**
  * Helper class for splitting commits by component path. If `packagePaths`
  * is configured, then only consider the provided paths. If `includeEmpty`
@@ -26,28 +27,14 @@ class CommitSplit {
         opts = opts || {};
         this.includeEmpty = !!opts.includeEmpty;
         if (opts.packagePaths) {
-            const paths = [];
-            for (let newPath of opts.packagePaths) {
+            const paths = (0, commit_utils_1.normalizePaths)(opts.packagePaths);
+            this.packagePaths = paths
+                .filter(path => {
                 // The special "." path, representing the root of the module, should be
                 // ignored by commit-split as it is assigned all commits in manifest.ts
-                if (newPath === manifest_1.ROOT_PROJECT_PATH) {
-                    continue;
-                }
-                // normalize so that all paths have leading and trailing slashes for
-                // non-overlap validation.
-                // NOTE: GitHub API always returns paths using the `/` separator,
-                // regardless of what platform the client code is running on
-                newPath = newPath.replace(/\/$/, '');
-                newPath = newPath.replace(/^\//, '');
-                newPath = newPath.replace(/$/, '/');
-                newPath = newPath.replace(/^/, '/');
-                // store them with leading and trailing slashes removed.
-                newPath = newPath.replace(/\/$/, '');
-                newPath = newPath.replace(/^\//, '');
-                paths.push(newPath);
-            }
-            // sort by longest paths first
-            this.packagePaths = paths.sort((a, b) => b.length - a.length);
+                return path !== manifest_1.ROOT_PROJECT_PATH;
+            })
+                .sort((a, b) => b.length - a.length); // sort by longest paths first
         }
     }
     /**

package/build/src/util/commit-utils.d.ts

@@ -0,0 +1 @@
+export declare const normalizePaths: (paths: string[]) => string[];

package/build/src/util/commit-utils.js

@@ -0,0 +1,34 @@
+"use strict";
+// Copyright 2023 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.normalizePaths = void 0;
+const normalizePaths = (paths) => {
+    return paths.map(path => {
+        // normalize so that all paths have leading and trailing slashes for
+        // non-overlap validation.
+        // NOTE: GitHub API always returns paths using the `/` separator,
+        // regardless of what platform the client code is running on
+        let newPath = path.replace(/\/$/, '');
+        newPath = newPath.replace(/^\//, '');
+        newPath = newPath.replace(/$/, '/');
+        newPath = newPath.replace(/^/, '/');
+        // store them with leading and trailing slashes removed.
+        newPath = newPath.replace(/\/$/, '');
+        newPath = newPath.replace(/^\//, '');
+        return newPath;
+    });
+};
+exports.normalizePaths = normalizePaths;
+//# sourceMappingURL=commit-utils.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "release-please",
-  "version": "15.9.2",
+  "version": "15.10.0",
   "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

@@ -184,6 +184,13 @@
             ]
           }
         },
+        "exclude-paths": {
+          "description": "Path of commits to be excluded from parsing. If all files from commit belong to one of the paths it will be skipped",
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
         "version-file": {
           "description": "Path to the specialize version file. Used by `ruby` and `simple` strategies.",
           "type": "string"
@@ -394,6 +401,7 @@
     "extra-files": true,
     "version-file": true,
     "snapshot-label": true,
-    "initial-version": true
+    "initial-version": true,
+    "exclude-paths": true
   }
 }