release-please 13.0.0-candidate.2 → 13.0.0

package/CHANGELOG.md

@@ -4,6 +4,58 @@
 
 [1]: https://www.npmjs.com/package/release-please?activeTab=versions
 
+## [13.0.0](https://www.github.com/googleapis/release-please/compare/v12.6.0...v13.0.0) (2021-12-22)
+
+
+### ⚠ BREAKING CHANGES
+
+* releasers are now "strategies", more logic moved into base classes
+* Node 12 is now required
+* manifest is now main entrypoint for release please, and logic is shared between mono-repo/split-repo flow
+* versioning straregy now handled by VersionStrategies rather than regexes
+* merge Manifest and standard PR paths (#1104)
+
+### Features
+
+* add `includeComponentInTag` option for strategies and hook up to `--monorepo-tags` ([#1119](https://www.github.com/googleapis/release-please/issues/1119)) ([bf9aacd](https://www.github.com/googleapis/release-please/commit/bf9aacdde3a97c453f6e3280035607c97c7dffcd))
+* add ability to override merged commit message ([#1161](https://www.github.com/googleapis/release-please/issues/1161)) ([c568b57](https://www.github.com/googleapis/release-please/commit/c568b57280f2048f6dabbb716cdb4174c3386b91)), closes [#967](https://www.github.com/googleapis/release-please/issues/967)
+* add GitHub changelog notes generator ([#1120](https://www.github.com/googleapis/release-please/issues/1120)) ([1470661](https://www.github.com/googleapis/release-please/commit/1470661bd76a1e731585ed3fbf7363224c7a7a3e))
+* enable specifying changelog section headings in the CLI ([#1162](https://www.github.com/googleapis/release-please/issues/1162)) ([aaa8342](https://www.github.com/googleapis/release-please/commit/aaa8342cd48062c56fe87b3296904274b7fb9dbe)), closes [#511](https://www.github.com/googleapis/release-please/issues/511)
+* **go:** add support for bumping a Go version file ([#1112](https://www.github.com/googleapis/release-please/issues/1112)) ([8f6e52b](https://www.github.com/googleapis/release-please/commit/8f6e52b27811e6838800c7152be74e13201eb9e1))
+* reimplement custom pull request title ([#1122](https://www.github.com/googleapis/release-please/issues/1122)) ([2f3e84c](https://www.github.com/googleapis/release-please/commit/2f3e84c8c51f367cad8baae44c8d9f0727aa02a5))
+* reimplement Java 1.0.0 special version bumping ([#1126](https://www.github.com/googleapis/release-please/issues/1126)) ([28bc76b](https://www.github.com/googleapis/release-please/commit/28bc76b35d9e1eff218a5be1b9b8cebb4b1e6f9d))
+* return path along with created release ([#1114](https://www.github.com/googleapis/release-please/issues/1114)) ([81fc0f4](https://www.github.com/googleapis/release-please/commit/81fc0f49d75ec66ef1915be26330734abddd11d7))
+
+
+### Bug Fixes
+
+* add back version/major/minor/patch ([#1118](https://www.github.com/googleapis/release-please/issues/1118)) ([4b6ae50](https://www.github.com/googleapis/release-please/commit/4b6ae5049e39e6f5bca10b514256090ea76ef5bd))
+* allow setting release-type at root of manifest config ([#1159](https://www.github.com/googleapis/release-please/issues/1159)) ([fc73b6d](https://www.github.com/googleapis/release-please/commit/fc73b6dd3f5f7ed449b9d304e53bada911e3190f))
+* backfill commit files ([#1110](https://www.github.com/googleapis/release-please/issues/1110)) ([173ce70](https://www.github.com/googleapis/release-please/commit/173ce704c9413d7f0da820fdd2961166a5ff0b73))
+* backfill latest release with version found in manifest ([#1131](https://www.github.com/googleapis/release-please/issues/1131)) ([94859a0](https://www.github.com/googleapis/release-please/commit/94859a0cfbc58724016daaefaca03f34a43e0473))
+* **cli:** pass pull-request-title-pattern ([#1128](https://www.github.com/googleapis/release-please/issues/1128)) ([28d7727](https://www.github.com/googleapis/release-please/commit/28d7727bc827612b02a8fde58d13cd87f962a399))
+* combined manifest PR should include labels ([#1137](https://www.github.com/googleapis/release-please/issues/1137)) ([d8bb7ca](https://www.github.com/googleapis/release-please/commit/d8bb7caddfa14aabd3bfa19008c10ed911638a66))
+* fallback to look at releases when looking for latest release ([#1146](https://www.github.com/googleapis/release-please/issues/1146)) ([76ed1a7](https://www.github.com/googleapis/release-please/commit/76ed1a77e64f28b0af7d8125dce457b885f80e52))
+* fallback to look at tags when looking for latest release ([#1160](https://www.github.com/googleapis/release-please/issues/1160)) ([e06c6ba](https://www.github.com/googleapis/release-please/commit/e06c6ba5c3ce29689275e495934d4a6785962d5b))
+* GitHub#findFilesByExtension should treat prefix as a directory ([#1165](https://www.github.com/googleapis/release-please/issues/1165)) ([b48ec5b](https://www.github.com/googleapis/release-please/commit/b48ec5bc285233436d7cb1b367326a3c6dd555a9))
+* **github:** correctly return maxResults releases ([#1134](https://www.github.com/googleapis/release-please/issues/1134)) ([25f6811](https://www.github.com/googleapis/release-please/commit/25f68113d0e0bfa5a181d616c11bfd5e573cfaf5))
+* make PullRequest, ReleasePullRequest, Version fields readonly ([#1150](https://www.github.com/googleapis/release-please/issues/1150)) ([9659c1c](https://www.github.com/googleapis/release-please/commit/9659c1c868395394a40ff8f6caf9aaa7998fb8b8))
+* Manifest.fromConfig can find latest release version without component ([#1123](https://www.github.com/googleapis/release-please/issues/1123)) ([0aeb67b](https://www.github.com/googleapis/release-please/commit/0aeb67b4c4a497b5570bdec10f5ab15e620b235d))
+* merge manifest release PRs unless separatePullRequests is configured ([#1129](https://www.github.com/googleapis/release-please/issues/1129)) ([328009d](https://www.github.com/googleapis/release-please/commit/328009d10b4609441a6f8432fa0d2aa9df1f5ff0))
+* only backfill files if requested ([#1151](https://www.github.com/googleapis/release-please/issues/1151)) ([ae007fe](https://www.github.com/googleapis/release-please/commit/ae007feb430e97f2995d6fd431f2825512651e3a))
+* reimplement draft releases ([#1111](https://www.github.com/googleapis/release-please/issues/1111)) ([6f38b4a](https://www.github.com/googleapis/release-please/commit/6f38b4aa5a206b358468e623a020ef715257ddfe))
+* **rust:** Don't update dev-dependencies lacking a version key ([#1095](https://www.github.com/googleapis/release-please/issues/1095)) ([#1152](https://www.github.com/googleapis/release-please/issues/1152)) ([56f37d9](https://www.github.com/googleapis/release-please/commit/56f37d997c75ec5bcc330b08b0e9e25c68329b7a)), closes [#1094](https://www.github.com/googleapis/release-please/issues/1094)
+* switch branch delimiter to `--` ([#1127](https://www.github.com/googleapis/release-please/issues/1127)) ([26442f1](https://www.github.com/googleapis/release-please/commit/26442f14356c387c9117f5d660b532185c8084c4))
+
+
+### Code Refactoring
+
+* manifest is now main entrypoint for release please, and logic is shared between mono-repo/split-repo flow ([fd8f9fc](https://www.github.com/googleapis/release-please/commit/fd8f9fc82838f3a3a05470dfe4dab4d3b47c6fa1))
+* merge Manifest and standard PR paths ([#1104](https://www.github.com/googleapis/release-please/issues/1104)) ([fd8f9fc](https://www.github.com/googleapis/release-please/commit/fd8f9fc82838f3a3a05470dfe4dab4d3b47c6fa1))
+* Node 12 is now required ([fd8f9fc](https://www.github.com/googleapis/release-please/commit/fd8f9fc82838f3a3a05470dfe4dab4d3b47c6fa1))
+* releasers are now "strategies", more logic moved into base classes ([fd8f9fc](https://www.github.com/googleapis/release-please/commit/fd8f9fc82838f3a3a05470dfe4dab4d3b47c6fa1))
+* versioning straregy now handled by VersionStrategies rather than regexes ([fd8f9fc](https://www.github.com/googleapis/release-please/commit/fd8f9fc82838f3a3a05470dfe4dab4d3b47c6fa1))
+
 ## [12.6.0](https://www.github.com/googleapis/release-please/compare/v12.5.0...v12.6.0) (2021-10-11)
 
 

package/README.md

@@ -75,6 +75,8 @@ The above commit message will contain:
   that it's a breaking change.
 3. an entry for the feature **"update encode to support unicode"**.
 
+> :warning: **Important:** The additional messages must be added to the bottom of the commit.
+
 ## How do I change the version number?
 
 When a commit to the main branch has `Release-As: x.x.x`(case insensitive) in the **commit body**, Release Please will open a new pull request for the specified version.
@@ -89,31 +91,25 @@ chore: release 2.0.0
 Release-As: 2.0.0
 ```
 
-## Release types supported
+## Strategy (Language) types supported
 
 Release Please automates releases for the following flavors of repositories:
 
 | release type            | description
 |-------------------|---------------------------------------------------------|
-| node              | [A Node.js repository, with a package.json and CHANGELOG.md](https://github.com/yargs/yargs) |
-| 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 |
-| 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) |
-| krm-blueprint     | [A kpt package, with 1 or more KRM files and a CHANGELOG.md](https://github.com/GoogleCloudPlatform/blueprints/tree/main/catalog/project) |
-| rust              | A Rust repository, with a Cargo.toml (either as a crate or workspace) and a CHANGELOG.md |
-| ocaml             | [An OCaml repository, containing 1 or more opam or esy files and a CHANGELOG.md](https://github.com/grain-lang/binaryen.ml) |
-| simple            | [A repository with a version.txt and a CHANGELOG.md](https://github.com/googleapis/gapic-generator) |
-| helm              | A repository with a Chart.yaml and a CHANGELOG.md |
-| elixir            | A repository with a mix.exs and a CHANGELOG.md |
-| dart              | A repository with a pubspec.yaml and a CHANGELOG.md |
-
-## Adding additional release types
-
-To add a new release type, simply use the existing [releasers](https://github.com/googleapis/release-please/tree/main/src/releasers) and [updaters](https://github.com/googleapis/release-please/tree/main/src/updaters)
-as a starting point.
-
-**releasers** describe the files that should be updated for a release.
-
-**updaters** describe how to update the version in these files.
+| `dart`              | A repository with a pubspec.yaml and a CHANGELOG.md |
+| `elixir`            | A repository with a mix.exs and a CHANGELOG.md |
+| `go`                | A repository with a CHANGELOG.md |
+| `helm`              | A repository with a Chart.yaml and a CHANGELOG.md |
+| `krm-blueprint`     | [A kpt package, with 1 or more KRM files and a CHANGELOG.md](https://github.com/GoogleCloudPlatform/blueprints/tree/main/catalog/project) |
+| `node`              | [A Node.js repository, with a package.json and CHANGELOG.md](https://github.com/yargs/yargs) |
+| `ocaml`             | [An OCaml repository, containing 1 or more opam or esy files and a CHANGELOG.md](https://github.com/grain-lang/binaryen.ml) |
+| `php`               | A repository with a composer.json and a CHANGELOG.md |
+| `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 |
+| `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) |
 
 ## Setting up Release Please
 
@@ -121,128 +117,34 @@ There are a variety of ways you can deploy release-please:
 
 ### GitHub Action (recommended)
 
-The easiest way to run release please is as a GitHub action:
-
-1. If you haven't already done so, create a `.github/workflows` folder in your
-  repository (_this is where your actions will live_).
-2. Now create a `.github/workflows/release-please.yml` file with these contents:
-
-   ```yaml
-    on:
-      push:
-        branches:
-          - main
-    name: release-please
-    jobs:
-      release-please:
-        runs-on: ubuntu-latest
-        steps:
-          - uses: GoogleCloudPlatform/release-please-action@v2
-            with:
-              token: ${{ secrets.GITHUB_TOKEN }}
-              release-type: node
-              package-name: release-please-action
-    ```
-
-3. Merge the above action into your repository and make sure new commits follow
-  the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)
-  convention, [release-please](https://github.com/googleapis/release-please)
-  will start creating Release PRs for you.
-
-#### Automating publication to npm
-
-With a few additions, the Release Please action can be made to publish to
-npm when a Release PR is merged:
-
-```yaml
-on:
-  push:
-    branches:
-      - main
-name: release-please
-jobs:
-  release-please:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: GoogleCloudPlatform/release-please-action@v2
-        id: release
-        with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-          release-type: node
-          package-name: test-release-please
-      # The logic below handles the npm publication:
-      - uses: actions/checkout@v2
-        # these if statements ensure that a publication only occurs when
-        # a new release is created:
-        if: ${{ steps.release.outputs.release_created }}
-      - uses: actions/setup-node@v1
-        with:
-          node-version: 12
-          registry-url: 'https://registry.npmjs.org'
-        if: ${{ steps.release.outputs.release_created }}
-      # if you are using Yarn, substitute the command below with `yarn install --frozen-lockfile`
-      - run: npm ci
-        if: ${{ steps.release.outputs.release_created }}
-      - run: npm publish
-        env:
-          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
-        if: ${{ steps.release.outputs.release_created }}
-```
-
-> So that you can keep 2FA enabled for npm publications, we recommend setting
-`registry-url` to your own [Wombat Dressing Room](https://github.com/GoogleCloudPlatform/wombat-dressing-room) deployment.
+The easiest way to run release please is as a GitHub action. Please see [google-github-actions/release-please-action](https://github.com/google-github-actions/release-please-action) for installation and configuration instructions.
 
 ### Running as CLI
 
-Install release-please globally:
+Please see [Running release-please CLI](docs/cli.md) for all the configuration options.
 
-```bash
-npm i release-please -g
-```
+### Install the GitHub App
 
-### Creating/updating release PRs
+There is a probot application available, which allows you to deploy Release
+Please as a GitHub App. Please see 
+[github.com/googleapis/repo-automation-bots](https://github.com/googleapis/repo-automation-bots/tree/main/packages/release-please)
+for installation and configuration instructions.
 
-```bash
-release-please release-pr --package-name=@google-cloud/firestore" \
-  --repo-url=googleapis/nodejs-firestore \
-  --token=$GITHUB_TOKEN
-```
+## Bootstrapping your Repository
 
-| option            | description                                             |
-|-------------------|---------------------------------------------------------|
-| `--package-name`  | is the name of the package to publish to publish to an upstream registry such as npm. |
-| `--repo-url`      | is the URL of the repository on GitHub.                 |
-| `--token`         | a token with write access to `--repo-url`.              |
-| `--default-branch`| branch to open pull release PR against (detected by default). |
-| `--path`          | create a release from a path other than the repository's root |
-| `--monorepo-tags` | add prefix to tags and branches, allowing multiple libraries to be released from the same repository. |
-| `--pull-request-title-pattern` | add title pattern to make release PR, defaults to using `chore${scope}: release${component} ${version}`. |
-| `--signoff` | Add [`Signed-off-by`](https://git-scm.com/docs/git-commit#Documentation/git-commit.txt---signoff) line at the end of the commit log message using the user and email provided. (format "Name \<email@example.com\>") |
-| `--api-url` | URL to use when making API requests [default: "https://api.github.com"] |
-| `--graphql-url` | URL to use when making GraphQL requests [default: "https://api.github.com"] |
-
-### Creating a release on GitHub
-
-```bash
-release-please github-release --repo-url=googleapis/nodejs-firestore \
-  --token=$GITHUB_TOKEN
-```
+Release Please looks at commits since your last release tag. It may or may not be able to find
+your previous releases. The easiest way to on-board your repository is to
+[bootstrap a manifest config](/docs/cli.md#bootstrapping).
 
-| option            | description                                             |
-|-------------------|---------------------------------------------------------|
-| `--package-name`  | is the name of the package to publish to publish to  an upstream registry such as npm. |
-| `--repo-url`      | is the URL of the repository on GitHub.                 |
-| `--token`         | a token with write access to `--repo-url`.              |
-| `--path`          | create a release from a path other than the repository's root |
-| `--api-url`       | URL to use when making API requests [default: "https://api.github.com"] |
-| `--graphql-url`   | URL to use when making GraphQL requests [default: "https://api.github.com"] |
+## Customizing Release Please
 
-### Running as a GitHub App
+Release Please provides several configuration options to allow customizing
+your release process. Please see [customizing.md](docs/customizing.md) for more details.
 
-There is a probot application available, which allows you to deploy Release
-Please as a GitHub App:
+## Supporting Monorepos via Manifest Configuration
 
-* [github.com/googleapis/repo-automation-bots](https://github.com/googleapis/repo-automation-bots/tree/main/packages/release-please).
+Release Please also supports releasing multiple artifacts from the same repository.
+See more at [manifest-releaser.md](docs/manifest-releaser.md).
 
 ## Supported Node.js Versions
 

package/build/src/bin/release-please.d.ts

@@ -53,7 +53,6 @@ interface PullRequestStrategyArgs {
     changelogPath?: string;
     versioningStrategy?: VersioningStrategyType;
     versionFile?: string;
-    pullRequestTitlePattern?: string;
     extraFiles?: string[];
 }
 interface BootstrapArgs extends GitHubArgs, ManifestArgs, ManifestConfigArgs, VersioningArgs, PullRequestArgs, PullRequestStrategyArgs, ReleaseArgs {

package/build/src/bin/release-please.js

@@ -19,6 +19,7 @@ const coerce_option_1 = require("../util/coerce-option");
 const yargs = require("yargs");
 const github_1 = require("../github");
 const manifest_1 = require("../manifest");
+const changelog_notes_1 = require("../changelog-notes");
 const logger_1 = require("../util/logger");
 const factory_1 = require("../factory");
 const bootstrapper_1 = require("../bootstrapper");
@@ -148,15 +149,25 @@ function pullRequestStrategyOptions(yargs) {
         describe: 'strategy used for bumping versions',
         choices: factory_1.getVersioningStrategyTypes(),
         default: 'default',
-    })
-        .option('pull-request-title-pattern', {
-        describe: 'Title pattern to make release PR',
-        type: 'string',
     })
         .option('changelog-path', {
         default: 'CHANGELOG.md',
         describe: 'where can the CHANGELOG be found in the project?',
         type: 'string',
+    })
+        .option('changelog-type', {
+        describe: 'type of changelog to build',
+        choices: factory_1.getChangelogTypes(),
+    })
+        .option('changelog-sections', {
+        describe: 'comma-separated list of scopes to include in the changelog',
+        type: 'string',
+        coerce: (arg) => {
+            if (arg) {
+                return changelog_notes_1.buildChangelogSections(arg.split(','));
+            }
+            return arg;
+        },
     })
         .option('last-package-version', {
         describe: 'last version # that package was released as',
@@ -220,10 +231,15 @@ function manifestOptions(yargs) {
     });
 }
 function taggingOptions(yargs) {
-    return yargs.option('monorepo-tags', {
+    return yargs
+        .option('monorepo-tags', {
         describe: 'include library name in tags and release branches',
         type: 'boolean',
         default: false,
+    })
+        .option('pull-request-title-pattern', {
+        describe: 'Title pattern to make release PR',
+        type: 'string',
     });
 }
 const createReleasePullRequestCommand = {
@@ -245,6 +261,8 @@ const createReleasePullRequestCommand = {
                 bumpMinorPreMajor: argv.bumpMinorPreMajor,
                 bumpPatchForMinorPreMajor: argv.bumpPatchForMinorPreMajor,
                 changelogPath: argv.changelogPath,
+                changelogType: argv.changelogType,
+                pullRequestTitlePattern: argv.pullRequestTitlePattern,
                 changelogSections: argv.changelogSections,
                 releaseAs: argv.releaseAs,
                 versioning: argv.versioningStrategy,
@@ -382,7 +400,7 @@ const bootstrapCommand = {
     command: 'bootstrap',
     describe: 'configure release manifest',
     builder(yargs) {
-        return manifestOptions(releaseOptions(pullRequestStrategyOptions(gitHubOptions(yargs))))
+        return manifestConfigOptions(manifestOptions(releaseOptions(pullRequestStrategyOptions(gitHubOptions(yargs)))))
             .option('initial-version', {
             description: 'current version',
         })

package/build/src/changelog-notes/default.d.ts

@@ -1,13 +1,11 @@
-import { ChangelogSection, ChangelogNotes, BuildNotesOptions } from '../changelog-notes';
+import { ChangelogNotes, BuildNotesOptions } from '../changelog-notes';
 import { ConventionalCommit } from '../commit';
 interface DefaultChangelogNotesOptions {
-    changelogSections?: ChangelogSection[];
     commitPartial?: string;
     headerPartial?: string;
     mainTemplate?: string;
 }
 export declare class DefaultChangelogNotes implements ChangelogNotes {
-    private changelogSections?;
     private commitPartial?;
     private headerPartial?;
     private mainTemplate?;

package/build/src/changelog-notes/default.js

@@ -21,7 +21,6 @@ const presetFactory = require('conventional-changelog-conventionalcommits');
 const DEFAULT_HOST = 'https://github.com';
 class DefaultChangelogNotes {
     constructor(options = {}) {
-        this.changelogSections = options.changelogSections;
         this.commitPartial = options.commitPartial;
         this.headerPartial = options.headerPartial;
         this.mainTemplate = options.mainTemplate;
@@ -37,8 +36,8 @@ class DefaultChangelogNotes {
             linkCompare: !!options.previousTag,
         };
         const config = {};
-        if (this.changelogSections) {
-            config.types = this.changelogSections;
+        if (options.changelogSections) {
+            config.types = options.changelogSections;
         }
         const preset = await presetFactory(config);
         preset.writerOpts.commitPartial =

package/build/src/changelog-notes/github.d.ts

@@ -0,0 +1,8 @@
+import { ChangelogNotes, BuildNotesOptions } from '../changelog-notes';
+import { ConventionalCommit } from '../commit';
+import { GitHub } from '../github';
+export declare class GitHubChangelogNotes implements ChangelogNotes {
+    private github;
+    constructor(github: GitHub);
+    buildNotes(_commits: ConventionalCommit[], options: BuildNotesOptions): Promise<string>;
+}

package/build/src/changelog-notes/github.js

@@ -0,0 +1,26 @@
+"use strict";
+// Copyright 2021 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.GitHubChangelogNotes = void 0;
+class GitHubChangelogNotes {
+    constructor(github) {
+        this.github = github;
+    }
+    async buildNotes(_commits, options) {
+        return await this.github.generateReleaseNotes(options.currentTag, options.targetBranch, options.previousTag);
+    }
+}
+exports.GitHubChangelogNotes = GitHubChangelogNotes;
+//# sourceMappingURL=github.js.map

package/build/src/changelog-notes.d.ts

@@ -6,6 +6,8 @@ export interface BuildNotesOptions {
     version: string;
     previousTag?: string;
     currentTag: string;
+    targetBranch: string;
+    changelogSections?: ChangelogSection[];
 }
 export interface ChangelogNotes {
     buildNotes(commits: ConventionalCommit[], options: BuildNotesOptions): Promise<string>;
@@ -15,3 +17,4 @@ export interface ChangelogSection {
     section: string;
     hidden?: boolean;
 }
+export declare function buildChangelogSections(scopes: string[]): ChangelogSection[];

package/build/src/changelog-notes.js

@@ -13,4 +13,28 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildChangelogSections = void 0;
+const DEFAULT_HEADINGS = {
+    feat: 'Features',
+    fix: 'Bug Fixes',
+    perf: 'Performance Improvements',
+    deps: 'Dependencies',
+    revert: 'Reverts',
+    docs: 'Documentation',
+    style: 'Styles',
+    chore: 'Miscellaneous Chores',
+    refactor: 'Code Refactoring',
+    test: 'Tests',
+    build: 'Build System',
+    ci: 'Continuous Integration',
+};
+function buildChangelogSections(scopes) {
+    return scopes.map(scope => {
+        return {
+            type: scope,
+            section: DEFAULT_HEADINGS[scope] || scope,
+        };
+    });
+}
+exports.buildChangelogSections = buildChangelogSections;
 //# sourceMappingURL=changelog-notes.js.map

package/build/src/commit.d.ts

@@ -3,7 +3,7 @@ import * as parser from '@conventional-commits/parser';
 export interface Commit {
     sha: string;
     message: string;
-    files: string[];
+    files?: string[];
     pullRequest?: PullRequest;
 }
 export interface ConventionalCommit extends Commit {

package/build/src/commit.js

@@ -288,8 +288,9 @@ function parseCommits(message) {
 function parseConventionalCommits(commits) {
     const conventionalCommits = [];
     for (const commit of commits) {
+        const commitMessage = preprocessCommitMessage(commit);
         try {
-            for (const parsedCommit of parseCommits(commit.message)) {
+            for (const parsedCommit of parseCommits(commitMessage)) {
                 const breaking = parsedCommit.notes.filter(note => note.title === 'BREAKING CHANGE')
                     .length > 0;
                 conventionalCommits.push({
@@ -313,4 +314,16 @@ function parseConventionalCommits(commits) {
     return conventionalCommits;
 }
 exports.parseConventionalCommits = parseConventionalCommits;
+function preprocessCommitMessage(commit) {
+    // look for 'BEGIN_COMMIT_OVERRIDE' section of pull request body
+    if (commit.pullRequest) {
+        const overrideMessage = (commit.pullRequest.body.split('BEGIN_COMMIT_OVERRIDE')[1] || '')
+            .split('END_COMMIT_OVERRIDE')[0]
+            .trim();
+        if (overrideMessage) {
+            return overrideMessage;
+        }
+    }
+    return commit.message;
+}
 //# sourceMappingURL=commit.js.map

package/build/src/factory.d.ts

@@ -2,10 +2,12 @@ import { Strategy } from './strategy';
 import { GitHub } from './github';
 import { ReleaserConfig, PluginType, RepositoryConfig } from './manifest';
 import { ManifestPlugin } from './plugin';
+import { ChangelogNotes, ChangelogSection } from './changelog-notes';
 declare const allReleaseTypes: readonly ["dart", "elixir", "go", "go-yoshi", "helm", "java-backport", "java-bom", "java-lts", "java-yoshi", "krm-blueprint", "node", "ocaml", "php", "php-yoshi", "python", "ruby", "ruby-yoshi", "rust", "simple", "terraform-module"];
 export declare type ReleaseType = typeof allReleaseTypes[number];
 export declare function getReleaserTypes(): readonly ReleaseType[];
 export declare function getVersioningStrategyTypes(): readonly VersioningStrategyType[];
+export declare function getChangelogTypes(): readonly ChangelogNotesType[];
 export interface StrategyFactoryOptions extends ReleaserConfig {
     github: GitHub;
     path?: string;
@@ -23,4 +25,15 @@ interface PluginFactoryOptions {
     updateAllPackages?: boolean;
 }
 export declare function buildPlugin(options: PluginFactoryOptions): ManifestPlugin;
+declare const allChangelogNotesTypes: readonly ["default", "github"];
+export declare type ChangelogNotesType = typeof allChangelogNotesTypes[number];
+interface ChangelogNotesFactoryOptions {
+    type: ChangelogNotesType;
+    github: GitHub;
+    changelogSections?: ChangelogSection[];
+    commitPartial?: string;
+    headerPartial?: string;
+    mainTemplate?: string;
+}
+export declare function buildChangelogNotes(options: ChangelogNotesFactoryOptions): ChangelogNotes;
 export {};

package/build/src/factory.js

@@ -13,7 +13,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.buildPlugin = exports.buildStrategy = exports.getVersioningStrategyTypes = exports.getReleaserTypes = void 0;
+exports.buildChangelogNotes = exports.buildPlugin = exports.buildStrategy = exports.getChangelogTypes = exports.getVersioningStrategyTypes = exports.getReleaserTypes = void 0;
 const go_1 = require("./strategies/go");
 const go_yoshi_1 = require("./strategies/go-yoshi");
 const java_yoshi_1 = require("./strategies/java-yoshi");
@@ -37,6 +37,8 @@ const service_pack_1 = require("./versioning-strategies/service-pack");
 const dependency_manifest_1 = require("./versioning-strategies/dependency-manifest");
 const node_workspace_1 = require("./plugins/node-workspace");
 const cargo_workspace_1 = require("./plugins/cargo-workspace");
+const github_1 = require("./changelog-notes/github");
+const default_2 = require("./changelog-notes/default");
 // Factory shared by GitHub Action and CLI for creating Release PRs
 // and GitHub Releases:
 // add any new releasers you create to this type as well as the `releasers`
@@ -87,6 +89,10 @@ function getVersioningStrategyTypes() {
     return allVersioningTypes;
 }
 exports.getVersioningStrategyTypes = getVersioningStrategyTypes;
+function getChangelogTypes() {
+    return allChangelogNotesTypes;
+}
+exports.getChangelogTypes = getChangelogTypes;
 async function buildStrategy(options) {
     var _a;
     const targetBranch = (_a = options.targetBranch) !== null && _a !== void 0 ? _a : options.github.repository.defaultBranch;
@@ -95,6 +101,11 @@ async function buildStrategy(options) {
         bumpMinorPreMajor: options.bumpMinorPreMajor,
         bumpPatchForMinorPreMajor: options.bumpPatchForMinorPreMajor,
     });
+    const changelogNotes = buildChangelogNotes({
+        type: options.changelogType || 'default',
+        github: options.github,
+        changelogSections: options.changelogSections,
+    });
     const strategyOptions = {
         github: options.github,
         targetBranch,
@@ -109,6 +120,8 @@ async function buildStrategy(options) {
         skipGitHubRelease: options.skipGithubRelease,
         releaseAs: options.releaseAs,
         includeComponentInTag: options.includeComponentInTag,
+        changelogNotes,
+        pullRequestTitlePattern: options.pullRequestTitlePattern,
     };
     switch (options.releaseType) {
         case 'ruby': {
@@ -189,4 +202,16 @@ function buildPlugin(options) {
     }
 }
 exports.buildPlugin = buildPlugin;
+const allChangelogNotesTypes = ['default', 'github'];
+function buildChangelogNotes(options) {
+    switch (options.type) {
+        case 'github':
+            return new github_1.GitHubChangelogNotes(options.github);
+        case 'default':
+            return new default_2.DefaultChangelogNotes(options);
+        default:
+            throw new Error(`Unknown changelog type: ${options.type}`);
+    }
+}
+exports.buildChangelogNotes = buildChangelogNotes;
 //# sourceMappingURL=factory.js.map