release-please 15.5.1 → 15.7.0

package/CHANGELOG.md

@@ -4,6 +4,20 @@
 
 [1]: https://www.npmjs.com/package/release-please?activeTab=versions
 
+## [15.7.0](https://github.com/googleapis/release-please/compare/v15.6.0...v15.7.0) (2023-02-07)
+
+
+### Features
+
+* **changelog.json:** Implement changelog.json for python ([#1841](https://github.com/googleapis/release-please/issues/1841)) ([52594b1](https://github.com/googleapis/release-please/commit/52594b194fdd0ae516776128e6511d5e4cd21518))
+
+## [15.6.0](https://github.com/googleapis/release-please/compare/v15.5.1...v15.6.0) (2023-02-01)
+
+
+### Features
+
+* **changelog.json:** Add pr suffix to issues array ([#1839](https://github.com/googleapis/release-please/issues/1839)) ([fdd75ef](https://github.com/googleapis/release-please/commit/fdd75efbc276d432f1d9d54f1790f4852a4aa3f7))
+
 ## [15.5.1](https://github.com/googleapis/release-please/compare/v15.5.0...v15.5.1) (2023-01-30)
 
 

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

@@ -5,5 +5,7 @@ export declare class Python extends BaseStrategy {
     constructor(options: BaseStrategyOptions);
     protected buildUpdates(options: BuildUpdatesOptions): Promise<Update[]>;
     private getPyProject;
+    protected getNameFromSetupPy(): Promise<string | null>;
+    protected getSetupPyContents(): Promise<string | null>;
     protected initialReleaseVersion(): Version;
 }

package/build/src/strategies/python.js

@@ -16,11 +16,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Python = void 0;
 const base_1 = require("./base");
 const changelog_1 = require("../updaters/changelog");
+const changelog_json_1 = require("../updaters/changelog-json");
 const version_1 = require("../version");
 const setup_cfg_1 = require("../updaters/python/setup-cfg");
 const setup_py_1 = require("../updaters/python/setup-py");
 const pyproject_toml_1 = require("../updaters/python/pyproject-toml");
 const python_file_with_version_1 = require("../updaters/python/python-file-with-version");
+const errors_1 = require("../errors");
+const filter_commits_1 = require("../util/filter-commits");
 const CHANGELOG_SECTIONS = [
     { type: 'feat', section: 'Features' },
     { type: 'fix', section: 'Bug Fixes' },
@@ -112,6 +115,21 @@ class Python extends base_1.BaseStrategy {
                 }),
             });
         });
+        // If a machine readable changelog.json exists update it:
+        const artifactName = projectName !== null && projectName !== void 0 ? projectName : (await this.getNameFromSetupPy());
+        if (options.commits && artifactName) {
+            const commits = (0, filter_commits_1.filterCommits)(options.commits, this.changelogSections);
+            updates.push({
+                path: 'changelog.json',
+                createIfMissing: false,
+                updater: new changelog_json_1.ChangelogJson({
+                    artifactName,
+                    version,
+                    commits,
+                    language: 'PYTHON',
+                }),
+            });
+        }
         return updates;
     }
     async getPyProject(path) {
@@ -123,6 +141,31 @@ class Python extends base_1.BaseStrategy {
             return null;
         }
     }
+    async getNameFromSetupPy() {
+        var _a;
+        const ARTIFACT_NAME_REGEX = /name *= *['"](?<name>.*)['"](\r|\n|$)/;
+        const setupPyContents = await this.getSetupPyContents();
+        if (setupPyContents) {
+            const match = setupPyContents.match(ARTIFACT_NAME_REGEX);
+            if (match && ((_a = match === null || match === void 0 ? void 0 : match.groups) === null || _a === void 0 ? void 0 : _a.name)) {
+                return match.groups.name;
+            }
+        }
+        return null;
+    }
+    async getSetupPyContents() {
+        try {
+            return (await this.github.getFileContentsOnBranch(this.addPath('setup.py'), this.targetBranch)).parsedContent;
+        }
+        catch (e) {
+            if (e instanceof errors_1.FileNotFoundError) {
+                return null;
+            }
+            else {
+                throw e;
+            }
+        }
+    }
     initialReleaseVersion() {
         return version_1.Version.parse('0.1.0');
     }

package/build/src/updaters/changelog-json.js

@@ -19,6 +19,7 @@ const default_1 = require("./default");
 const crypto_1 = require("crypto");
 const BREAKING_CHANGE_TITLE = 'BREAKING CHANGE';
 const COMMIT_PREFIX = /^[^:]+: ?/;
+const PR_SUFFIX_REGEX = / ?\(#(?<pr>[0-9]+)\)$/;
 /**
  * Maintians a machine readable CHANGELOG in chnagelog.json.
  * See: https://gist.github.com/bcoe/50ef0a0024bbf107cd5bc0adbdc04758
@@ -40,17 +41,33 @@ class ChangelogJson extends default_1.DefaultUpdater {
      * @returns {string} The updated content
      */
     updateContent(content, logger = logger_1.logger) {
+        var _a;
         const parsed = JSON.parse(content);
         logger.info(`adding release ${this.version} for ${this.artifactName}`);
         const changes = [];
         for (const commit of this.commits) {
+            const issues = new Set();
             // The commit.message field contains the type/scope prefix.
-            const message = commit.message.replace(COMMIT_PREFIX, '');
+            let message = commit.message.replace(COMMIT_PREFIX, '');
+            // When squashing commits, GitHub adds a suffix refrencing
+            // the # of the PR, e.g., chore(main): release 15.5.1 (#1838)
+            // this logic removes this suffix and prepends it to the
+            // issues array.
+            const match = message.match(PR_SUFFIX_REGEX);
+            if (match && ((_a = match.groups) === null || _a === void 0 ? void 0 : _a.pr)) {
+                message = message.replace(match[0], '');
+                issues.add(match.groups.pr);
+            }
+            // Array.from(someSet) will maintain elements in insertion
+            // order, given this we add references after the pr suffix.
+            for (const ref of commit.references) {
+                issues.add(ref.issue);
+            }
             const change = {
                 type: commit.type,
                 sha: commit.sha,
                 message: message,
-                issues: commit.references.map(ref => ref.issue),
+                issues: Array.from(issues),
             };
             if (commit.scope)
                 change.scope = commit.scope;

package/package.json

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