release-please 15.3.0 → 15.4.0

package/CHANGELOG.md

@@ -4,6 +4,20 @@
 
 [1]: https://www.npmjs.com/package/release-please?activeTab=versions
 
+## [15.4.0](https://github.com/googleapis/release-please/compare/v15.3.1...v15.4.0) (2023-01-26)
+
+
+### Features
+
+* **changelog.json:** Include referenced issues/prs ([#1830](https://github.com/googleapis/release-please/issues/1830)) ([bacbbb5](https://github.com/googleapis/release-please/commit/bacbbb52ad802d42af1ffb40e8c616cc6c6601a6))
+
+## [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)
 
 

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
@@ -152,12 +152,7 @@ class JavaYoshiMonoRepo extends java_1.Java {
                 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)) {
                     const repoMetadata = await this.getRepoMetadata(path);
                     const artifactName = repoMetadata

package/build/src/strategies/node.js

@@ -21,7 +21,7 @@ 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 BREAKING_CHANGE_NOTE = 'BREAKING CHANGE';
+const filter_commits_1 = require("../util/filter-commits");
 class Node extends base_1.BaseStrategy {
     async buildUpdates(options) {
         var _a;
@@ -64,12 +64,7 @@ class Node extends base_1.BaseStrategy {
         });
         // If a machine readable changelog.json exists update it:
         if (options.commits && packageName) {
-            const commits = options.commits.filter(commit => {
-                const isBreaking = commit.notes.find(note => {
-                    return note.title === BREAKING_CHANGE_NOTE;
-                });
-                return commit.type !== 'chore' || isBreaking;
-            });
+            const commits = (0, filter_commits_1.filterCommits)(options.commits, this.changelogSections);
             updates.push({
                 path: 'changelog.json',
                 createIfMissing: false,

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

@@ -50,6 +50,7 @@ class ChangelogJson extends default_1.DefaultUpdater {
                 type: commit.type,
                 sha: commit.sha,
                 message: message,
+                issues: commit.references.map(ref => ref.issue),
             };
             if (commit.scope)
                 change.scope = commit.scope;

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.3.0",
+  "version": "15.4.0",
   "description": "generate release PRs based on the conventionalcommits.org spec",
   "main": "./build/src/index.js",
   "bin": "./build/src/bin/release-please.js",