release-please 15.2.0 → 15.3.1

package/CHANGELOG.md

@@ -4,6 +4,23 @@
 
 [1]: https://www.npmjs.com/package/release-please?activeTab=versions
 
+## [15.3.1](https://github.com/googleapis/release-please/compare/v15.3.0...v15.3.1) (2023-01-26)
+
+
+### Bug Fixes
+
+* Filter changelog.json commits based on changelog sections ([#1827](https://github.com/googleapis/release-please/issues/1827)) ([844aacd](https://github.com/googleapis/release-please/commit/844aacd76434ae288ee3ac9b2061dd9406e99bd8))
+
+## [15.3.0](https://github.com/googleapis/release-please/compare/v15.2.0...v15.3.0) (2023-01-25)
+
+
+### Features
+
+* Add Salesforce strategy ([#1815](https://github.com/googleapis/release-please/issues/1815)) ([25b518f](https://github.com/googleapis/release-please/commit/25b518f4f34afcd749968d021f4eed99222a328a))
+* Add support for yarn workspace versions ([#1819](https://github.com/googleapis/release-please/issues/1819)) ([8b0cc7d](https://github.com/googleapis/release-please/commit/8b0cc7d7d203609c95e9e7cfbef4f0faedd3f46d))
+* **java-monorepo:** Switch to using .repo-metadata.json ([#1820](https://github.com/googleapis/release-please/issues/1820)) ([6cc85db](https://github.com/googleapis/release-please/commit/6cc85dbb95ade1c38c354a567a02b8a41d729a72))
+* **node:** Add support for changelog.json in Node ([#1823](https://github.com/googleapis/release-please/issues/1823)) ([d3e3bd3](https://github.com/googleapis/release-please/commit/d3e3bd3b102195befb051457f9a837ff47388157))
+
 ## [15.2.0](https://github.com/googleapis/release-please/compare/v15.1.2...v15.2.0) (2023-01-23)
 
 

package/README.md

@@ -150,6 +150,7 @@ Release Please automates releases for the following flavors of repositories:
 | `python`            | [A Python repository, with a setup.py, setup.cfg, CHANGELOG.md](https://github.com/googleapis/python-storage) and optionally a pyproject.toml and a <project>/\_\_init\_\_.py |
 | `ruby`              | A repository with a version.rb and a CHANGELOG.md |
 | `rust`              | A Rust repository, with a Cargo.toml (either as a crate or workspace) and a CHANGELOG.md |
+| `salesforce`        | A repository with a sfdx-project.json and a CHANGELOG.md |
 | `simple`            | [A repository with a version.txt and a CHANGELOG.md](https://github.com/googleapis/gapic-generator) |
 | `terraform-module`  | [A terraform module, with a version in the README.md, and a CHANGELOG.md](https://github.com/terraform-google-modules/terraform-google-project-factory) |
 

package/build/src/factory.js

@@ -40,6 +40,7 @@ const python_1 = require("./strategies/python");
 const ruby_1 = require("./strategies/ruby");
 const ruby_yoshi_1 = require("./strategies/ruby-yoshi");
 const rust_1 = require("./strategies/rust");
+const salesforce_1 = require("./strategies/salesforce");
 const simple_1 = require("./strategies/simple");
 const terraform_module_1 = require("./strategies/terraform-module");
 const helm_1 = require("./strategies/helm");
@@ -92,6 +93,7 @@ const releasers = {
     ruby: options => new ruby_1.Ruby(options),
     'ruby-yoshi': options => new ruby_yoshi_1.RubyYoshi(options),
     rust: options => new rust_1.Rust(options),
+    salesforce: options => new salesforce_1.Salesforce(options),
     simple: options => new simple_1.Simple(options),
     'terraform-module': options => new terraform_module_1.TerraformModule(options),
     helm: options => new helm_1.Helm(options),

package/build/src/plugins/node-workspace.js

@@ -118,7 +118,7 @@ class NodeWorkspace extends workspace_1.WorkspacePlugin {
                 this.logger.info(`${pkg.name}.${depName} updated to ${prefix}${depVersion.toString()}`);
             }
         }
-        const dependencyNotes = getChangelogDepsNotes(pkg, updatedPackage);
+        const dependencyNotes = getChangelogDepsNotes(pkg, updatedPackage, updatedVersions);
         existingCandidate.pullRequest.updates =
             existingCandidate.pullRequest.updates.map(update => {
                 if (update.path === (0, workspace_1.addPath)(existingCandidate.path, 'package.json')) {
@@ -172,7 +172,7 @@ class NodeWorkspace extends workspace_1.WorkspacePlugin {
                 this.logger.info(`${pkg.name}.${depName} updated to ${prefix}${depVersion.toString()}`);
             }
         }
-        const dependencyNotes = getChangelogDepsNotes(pkg, updatedPackage);
+        const dependencyNotes = getChangelogDepsNotes(pkg, updatedPackage, updatedVersions);
         const packageJson = updatedPackage.toJSON();
         const version = version_1.Version.parse(packageJson.version);
         const pullRequest = {
@@ -260,8 +260,8 @@ var SUPPORTED_RANGE_PREFIXES;
     SUPPORTED_RANGE_PREFIXES["EQUAL_OR_GREATER_THAN"] = ">=";
     SUPPORTED_RANGE_PREFIXES["EQUAL_OR_LESS_THAN"] = "<=";
 })(SUPPORTED_RANGE_PREFIXES || (SUPPORTED_RANGE_PREFIXES = {}));
-function getChangelogDepsNotes(original, updated) {
-    var _a;
+function getChangelogDepsNotes(original, updated, updateVersions) {
+    var _a, _b;
     let depUpdateNotes = '';
     const depTypes = [
         'dependencies',
@@ -280,6 +280,12 @@ function getChangelogDepsNotes(original, updated) {
             const origDepVer = (_a = original[depType]) === null || _a === void 0 ? void 0 : _a[depName];
             if (currentDepVer !== origDepVer) {
                 depUpdates.push(`\n    * ${depName} bumped from ${origDepVer} to ${currentDepVer}`);
+                //handle case when "workspace:" version is used
+            }
+            else if (currentDepVer.startsWith('workspace:') &&
+                updateVersions.get(depName) !== undefined) {
+                depUpdates.push(`\n    * ${depName} bumped to ${(_b = updateVersions
+                    .get(depName)) === null || _b === void 0 ? void 0 : _b.toString()}`);
             }
         }
         if (depUpdates.length > 0) {

package/build/src/strategies/java-yoshi-mono-repo.d.ts

@@ -15,7 +15,8 @@ export declare class JavaYoshiMonoRepo extends Java {
     protected buildVersionsMap(): Promise<VersionsMap>;
     protected getVersionsContent(): Promise<GitHubFileContents>;
     protected buildUpdates(options: JavaBuildUpdatesOption): Promise<Update[]>;
-    private getArtifactMap;
+    private hasChangelogJson;
+    private getRepoMetadata;
     protected updateVersionsMap(versionsMap: VersionsMap, conventionalCommits: ConventionalCommit[]): Promise<VersionsMap>;
     protected initialReleaseVersion(): Version;
 }

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

@@ -23,7 +23,7 @@ const composite_1 = require("../updaters/composite");
 const errors_1 = require("../errors");
 const java_1 = require("./java");
 const java_update_1 = require("../updaters/java/java-update");
-const BREAKING_CHANGE_NOTE = 'BREAKING CHANGE';
+const filter_commits_1 = require("../util/filter-commits");
 class JavaYoshiMonoRepo extends java_1.Java {
     /**
      * Override this method to post process commits
@@ -144,25 +144,24 @@ class JavaYoshiMonoRepo extends java_1.Java {
                     changelogEntry: options.changelogEntry,
                 }),
             });
-            // The artifact map maps from directory paths in repo to artifact names on
-            // Maven, e.g, java-secretmanager to com.google.cloud/google-cloud-secretmanager.
-            const artifactMap = await this.getArtifactMap('artifact-map.json');
-            if (artifactMap && options.commits) {
+            // Bail early if the repository has no root changelog.json.
+            // This file is used to opt into machine readable commits.
+            const hasChangelogJson = await this.hasChangelogJson();
+            if (hasChangelogJson && options.commits) {
                 const changelogUpdates = [];
                 const cs = new commit_split_1.CommitSplit({
                     includeEmpty: false,
                 });
-                const splitCommits = cs.split(options.commits.filter(commit => {
-                    const isBreaking = commit.notes.find(note => {
-                        return note.title === BREAKING_CHANGE_NOTE;
-                    });
-                    return commit.type !== 'chore' || isBreaking;
-                }));
+                const splitCommits = cs.split((0, filter_commits_1.filterCommits)(options.commits, this.changelogSections));
                 for (const path of Object.keys(splitCommits)) {
-                    if (artifactMap[path]) {
-                        this.logger.info(`Found artifact ${artifactMap[path]} for ${path}`);
+                    const repoMetadata = await this.getRepoMetadata(path);
+                    const artifactName = repoMetadata
+                        ? repoMetadata['distribution_name']
+                        : null;
+                    if (repoMetadata && artifactName) {
+                        this.logger.info(`Found artifact ${artifactName} for ${path}`);
                         changelogUpdates.push(new changelog_json_1.ChangelogJson({
-                            artifactName: artifactMap[path],
+                            artifactName,
                             version,
                             // We filter out "chore:" commits, to reduce noise in the upstream
                             // release notes. We will only show a product release note entry
@@ -181,13 +180,28 @@ class JavaYoshiMonoRepo extends java_1.Java {
         }
         return updates;
     }
-    async getArtifactMap(path) {
+    async hasChangelogJson() {
         try {
-            const content = await this.github.getFileContentsOnBranch(path, this.targetBranch);
-            return JSON.parse(content.parsedContent);
+            const content = await this.github.getFileContentsOnBranch('changelog.json', this.targetBranch);
+            return !!content;
         }
         catch (e) {
-            return null;
+            if (e instanceof errors_1.FileNotFoundError)
+                return false;
+            else
+                throw e;
+        }
+    }
+    async getRepoMetadata(path) {
+        try {
+            const content = await this.github.getFileContentsOnBranch(this.addPath(`${path}/.repo-metadata.json`), this.targetBranch);
+            return content ? JSON.parse(content.parsedContent) : null;
+        }
+        catch (e) {
+            if (e instanceof errors_1.FileNotFoundError)
+                return null;
+            else
+                throw e;
         }
     }
     async updateVersionsMap(versionsMap, conventionalCommits) {

package/build/src/strategies/node.js

@@ -15,11 +15,13 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Node = void 0;
 const base_1 = require("./base");
+const changelog_json_1 = require("../updaters/changelog-json");
 const package_lock_json_1 = require("../updaters/node/package-lock-json");
 const samples_package_json_1 = require("../updaters/node/samples-package-json");
 const changelog_1 = require("../updaters/changelog");
 const package_json_1 = require("../updaters/node/package-json");
 const errors_1 = require("../errors");
+const filter_commits_1 = require("../util/filter-commits");
 class Node extends base_1.BaseStrategy {
     async buildUpdates(options) {
         var _a;
@@ -60,6 +62,20 @@ class Node extends base_1.BaseStrategy {
                 version,
             }),
         });
+        // If a machine readable changelog.json exists update it:
+        if (options.commits && packageName) {
+            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: packageName,
+                    version,
+                    commits,
+                    language: 'JAVASCRIPT',
+                }),
+            });
+        }
         return updates;
     }
     async getDefaultPackageName() {

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

@@ -0,0 +1,9 @@
+import { BaseStrategy, BuildUpdatesOptions } from './base';
+import { Update } from '../update';
+import { GitHubFileContents } from '@google-automations/git-file-utils';
+export declare class Salesforce extends BaseStrategy {
+    private sfdxProjectJsonContents?;
+    protected buildUpdates(options: BuildUpdatesOptions): Promise<Update[]>;
+    getDefaultPackageName(): Promise<string | undefined>;
+    protected getSfdxProjectJsonContents(): Promise<GitHubFileContents>;
+}

package/build/src/strategies/salesforce.js

@@ -0,0 +1,66 @@
+"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.Salesforce = void 0;
+const base_1 = require("./base");
+const changelog_1 = require("../updaters/changelog");
+const errors_1 = require("../errors");
+const sfdx_project_json_1 = require("../updaters/salesforce/sfdx-project-json");
+const sfdxProjectJsonFileName = 'sfdx-project.json';
+class Salesforce extends base_1.BaseStrategy {
+    async buildUpdates(options) {
+        const updates = [];
+        const version = options.newVersion;
+        updates.push({
+            path: this.addPath(this.changelogPath),
+            createIfMissing: true,
+            updater: new changelog_1.Changelog({
+                version,
+                changelogEntry: options.changelogEntry,
+            }),
+        });
+        updates.push({
+            path: this.addPath(sfdxProjectJsonFileName),
+            createIfMissing: false,
+            cachedFileContents: this.sfdxProjectJsonContents,
+            updater: new sfdx_project_json_1.SfdxProjectJson({
+                version,
+            }),
+        });
+        return updates;
+    }
+    async getDefaultPackageName() {
+        const pkgJsonContents = await this.getSfdxProjectJsonContents();
+        const pkg = JSON.parse(pkgJsonContents.parsedContent);
+        return pkg.name;
+    }
+    async getSfdxProjectJsonContents() {
+        if (!this.sfdxProjectJsonContents) {
+            try {
+                this.sfdxProjectJsonContents =
+                    await this.github.getFileContentsOnBranch(this.addPath(sfdxProjectJsonFileName), this.targetBranch);
+            }
+            catch (e) {
+                if (e instanceof errors_1.FileNotFoundError) {
+                    throw new errors_1.MissingRequiredFileError(this.addPath(sfdxProjectJsonFileName), 'salesforce', `${this.repository.owner}/${this.repository.repo}`);
+                }
+                throw e;
+            }
+        }
+        return this.sfdxProjectJsonContents;
+    }
+}
+exports.Salesforce = Salesforce;
+//# sourceMappingURL=salesforce.js.map

package/build/src/updaters/salesforce/sfdx-project-json.d.ts

@@ -0,0 +1,21 @@
+import { Logger } from '../../util/logger';
+import { DefaultUpdater } from '../default';
+export type PackageDirectory = {
+    versionNumber: string;
+    default: boolean;
+};
+export type SfdxProjectFile = {
+    packageDirectories: PackageDirectory[];
+    name: string;
+};
+/**
+ * This updates a Salesfore sfdx-project.json file's main version.
+ */
+export declare class SfdxProjectJson extends DefaultUpdater {
+    /**
+     * Given initial file contents, return updated contents.
+     * @param {string} content The initial content
+     * @returns {string} The updated content
+     */
+    updateContent(content: string, logger?: Logger): string;
+}

package/build/src/updaters/salesforce/sfdx-project-json.js

@@ -0,0 +1,41 @@
+"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.SfdxProjectJson = void 0;
+const json_stringify_1 = require("../../util/json-stringify");
+const logger_1 = require("../../util/logger");
+const default_1 = require("../default");
+/**
+ * This updates a Salesfore sfdx-project.json file's main version.
+ */
+class SfdxProjectJson extends default_1.DefaultUpdater {
+    /**
+     * Given initial file contents, return updated contents.
+     * @param {string} content The initial content
+     * @returns {string} The updated content
+     */
+    updateContent(content, logger = logger_1.logger) {
+        const parsed = JSON.parse(content);
+        for (const packDir of parsed.packageDirectories) {
+            if (packDir.default) {
+                logger.info(`updating from ${packDir.versionNumber} to ${this.version}`);
+                packDir.versionNumber = `${this.version.toString()}.NEXT`;
+            }
+        }
+        return (0, json_stringify_1.jsonStringify)(parsed, content);
+    }
+}
+exports.SfdxProjectJson = SfdxProjectJson;
+//# sourceMappingURL=sfdx-project-json.js.map

package/build/src/util/filter-commits.d.ts

@@ -0,0 +1,12 @@
+import { ChangelogSection } from '../changelog-notes';
+import { ConventionalCommit } from '../commit';
+/**
+ * Given a set of conventional commits and the configured
+ * changelog sections provided by the user, return the set
+ * of commits that should be displayed:
+ *
+ * @param commits
+ * @param changelogSections
+ * @returns ConventionalCommit[]
+ */
+export declare function filterCommits(commits: ConventionalCommit[], changelogSections?: ChangelogSection[]): ConventionalCommit[];

package/build/src/util/filter-commits.js

@@ -0,0 +1,59 @@
+"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.filterCommits = void 0;
+const BREAKING_CHANGE_NOTE = 'BREAKING CHANGE';
+const DEFAULT_CHANGELOG_SECTIONS = [
+    { type: 'feat', section: 'Features' },
+    { type: 'fix', section: 'Bug Fixes' },
+    { type: 'perf', section: 'Performance Improvements' },
+    { type: 'revert', section: 'Reverts' },
+    { type: 'chore', section: 'Miscellaneous Chores', hidden: true },
+    { type: 'docs', section: 'Documentation', hidden: true },
+    { type: 'style', section: 'Styles', hidden: true },
+    { type: 'refactor', section: 'Code Refactoring', hidden: true },
+    { type: 'test', section: 'Tests', hidden: true },
+    { type: 'build', section: 'Build System', hidden: true },
+    { type: 'ci', section: 'Continuous Integration', hidden: true },
+];
+/**
+ * Given a set of conventional commits and the configured
+ * changelog sections provided by the user, return the set
+ * of commits that should be displayed:
+ *
+ * @param commits
+ * @param changelogSections
+ * @returns ConventionalCommit[]
+ */
+function filterCommits(commits, changelogSections) {
+    changelogSections = changelogSections !== null && changelogSections !== void 0 ? changelogSections : DEFAULT_CHANGELOG_SECTIONS;
+    const hiddenSections = [];
+    const visibleSections = [];
+    for (const section of changelogSections) {
+        if (!section.hidden)
+            visibleSections.push(section.type);
+        else
+            hiddenSections.push(section.type);
+    }
+    return commits.filter(commit => {
+        const isBreaking = commit.notes.find(note => {
+            return note.title === BREAKING_CHANGE_NOTE;
+        });
+        return (visibleSections.includes(commit.type) ||
+            (isBreaking && hiddenSections.includes(commit.type)));
+    });
+}
+exports.filterCommits = filterCommits;
+//# sourceMappingURL=filter-commits.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "release-please",
-  "version": "15.2.0",
+  "version": "15.3.1",
   "description": "generate release PRs based on the conventionalcommits.org spec",
   "main": "./build/src/index.js",
   "bin": "./build/src/bin/release-please.js",
@@ -44,10 +44,10 @@
     "@types/iarna__toml": "^2.0.1",
     "@types/js-yaml": "^4.0.0",
     "@types/jsonpath": "^0.2.0",
-    "@types/lerna__collect-updates": "^5.0.0",
-    "@types/lerna__package": "^5.0.0",
-    "@types/lerna__package-graph": "^5.0.0",
-    "@types/lerna__run-topologically": "^5.0.0",
+    "@types/lerna__collect-updates": "^5.1.0",
+    "@types/lerna__package": "^5.1.0",
+    "@types/lerna__package-graph": "^5.1.0",
+    "@types/lerna__run-topologically": "^5.1.0",
     "@types/mocha": "^9.0.0",
     "@types/node": "^18.0.0",
     "@types/pino": "^7.0.0",
@@ -70,10 +70,10 @@
     "@conventional-commits/parser": "^0.4.1",
     "@google-automations/git-file-utils": "^1.2.5",
     "@iarna/toml": "^2.2.5",
-    "@lerna/collect-updates": "^4.0.0",
-    "@lerna/package": "^4.0.0",
-    "@lerna/package-graph": "^4.0.0",
-    "@lerna/run-topologically": "^4.0.0",
+    "@lerna/collect-updates": "^6.4.1",
+    "@lerna/package": "^6.4.1",
+    "@lerna/package-graph": "^6.4.1",
+    "@lerna/run-topologically": "^6.4.1",
     "@octokit/graphql": "^5.0.0",
     "@octokit/request": "^6.0.0",
     "@octokit/request-error": "^3.0.0",