docs

chore(deps): update actions/checkout action to v4 (googleapis#2060) docs: check `autorelease: pending` or `autorelease: triggered` in an old PR (googleapis#1930) * docs: check `autorelease: pending` or `autorelease: triggered` in an old PR In googleapis/java-logging-logback#1050, I had to remove the "autorelease: pending " label to create a release pull request. * Update README.md fix mismerge --------- Co-authored-by: Jeff Ching <chingor@google.com> test: also test on node 18 (googleapis#2063) * test: also test on node 18 * ci: enable no-experimental-fetch for tests * ci: set NODE_OPTIONS for node 18 * set NODE_OPTIONS for windows build * set NODE_OPTIONS for windows build ci: only require node 18 tests (googleapis#2065) feat!: require node 18+ (googleapis#2069) fix(deps): bump semver dependency version (googleapis#2068) feat: Support pnpm workspaces (googleapis#2058) fix(deps): replace lerna dependency with lerna-lite Co-authored-by: Jeff Ching <chingor@google.com> fix(deps): upgrade http-proxy-agent to v7 (googleapis#2071) fix(deps): upgrade https-proxy-agent to v7 feat: fallback to root package version if package ignores github release (googleapis#1935) Co-authored-by: Jeff Ching <chingor@google.com> chore(deps): update dependency sinon to v16 (googleapis#2079) feat: Use default updaters based on file extension (googleapis#2072) * feat: Use default updaters based on file extension * use CompositeUpdater * improve things --------- Co-authored-by: Jeff Ching <chingor@google.com> chore(main): release 16.0.0 (googleapis#2070) Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com> config docs
kalosisz · Sep 19, 2023 · 92b83d8 · 92b83d8
1 parent ad44dc4
commit 92b83d8
Show file tree

Hide file tree

Showing 19 changed files with 3,136 additions and 722 deletions.
diff --git a/.github/sync-repo-settings.yaml b/.github/sync-repo-settings.yaml
@@ -11,8 +11,7 @@ branchProtectionRules:
       - cla/google
       - docs
       - lint
-      - test (14)
-      - test (16)
+      - test (18)
       - windows
   - pattern: 12.x
     isAdminEnforced: false

diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -9,9 +9,9 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node: [14, 16]
+        node: [18, 20]
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node }}
@@ -29,30 +29,30 @@ jobs:
   windows:
     runs-on: windows-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: actions/setup-node@v3
         with:
-          node-version: 14
+          node-version: 18
       - run: npm install
       - run: npm test
         env:
           MOCHA_THROW_DEPRECATION: false
   lint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: actions/setup-node@v3
         with:
-          node-version: 14
+          node-version: 18
       - run: npm install
       - run: npm run lint
   docs:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: actions/setup-node@v3
         with:
-          node-version: 14
+          node-version: 18
       - run: npm install
       - run: npm run docs
       - uses: JustinBeckwith/linkinator-action@v1

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,28 @@
 
 [1]: https://www.npmjs.com/package/release-please?activeTab=versions
 
+## [16.0.0](https://github.com/googleapis/release-please/compare/v15.13.0...v16.0.0) (2023-09-18)
+
+
+### ⚠ BREAKING CHANGES
+
+* require node 18+ ([#2069](https://github.com/googleapis/release-please/issues/2069))
+
+### Features
+
+* Fallback to root package version if package ignores github release ([#1935](https://github.com/googleapis/release-please/issues/1935)) ([0e11d4c](https://github.com/googleapis/release-please/commit/0e11d4c019f1e33cd713a237e037f31397d5371a))
+* Require node 18+ ([#2069](https://github.com/googleapis/release-please/issues/2069)) ([5a50247](https://github.com/googleapis/release-please/commit/5a5024727b93d0ba557b6f7ee5c6c1bab8d723d6))
+* Support pnpm workspaces ([#2058](https://github.com/googleapis/release-please/issues/2058)) ([13cba14](https://github.com/googleapis/release-please/commit/13cba14225cb836c74199d726a996f83122fab07))
+* Use default updaters based on file extension ([#2072](https://github.com/googleapis/release-please/issues/2072)) ([1ee162b](https://github.com/googleapis/release-please/commit/1ee162b3344e986afd09275f6762624e4a49faae))
+
+
+### Bug Fixes
+
+* **deps:** Bump semver dependency version ([#2068](https://github.com/googleapis/release-please/issues/2068)) ([cd0bd85](https://github.com/googleapis/release-please/commit/cd0bd853ac23087e5d5348c22f032fe0e533451d))
+* **deps:** Replace lerna dependency with lerna-lite ([13cba14](https://github.com/googleapis/release-please/commit/13cba14225cb836c74199d726a996f83122fab07))
+* **deps:** Upgrade http-proxy-agent to v7 ([#2071](https://github.com/googleapis/release-please/issues/2071)) ([cc50a34](https://github.com/googleapis/release-please/commit/cc50a34dee16115c07e574b05552678108f9e0c3))
+* **deps:** Upgrade https-proxy-agent to v7 ([cc50a34](https://github.com/googleapis/release-please/commit/cc50a34dee16115c07e574b05552678108f9e0c3))
+
 ## [15.13.0](https://github.com/googleapis/release-please/compare/v15.12.0...v15.13.0) (2023-08-18)
 
 

diff --git a/README.md b/README.md
@@ -139,7 +139,7 @@ recommend using squash-merge instead](#linear-git-commit-history-use-squash-merg
 
 ## Release Please bot does not create a release PR. Why?
 
-### Releasable Units
+### Step 1: Ensure releasable units are merged
 
 Release Please creates a release pull request after it notices the default branch
 contains "releasable units" since the last release.
@@ -150,15 +150,15 @@ prefixes: "feat", "fix", and "deps".
 Some languages have their specific releasable unit configuration. For example,
 "docs" is a prefix for releasable units in Java and Python.
 
-### Re-run Release Please
+### Step 2: Ensure no `autorelease: pending` or `autorelease: triggered` label in an old PR
 
-If you think Release Please missed creating a release PR after a pull request
-with a releasable unit has been merged, please re-run `release-please`. If you are using
-the GitHub application, add `release-please:force-run` label to the merged pull request. If
-you are using the action, look for the failed invocation and retry the workflow run.
-Release Please will process the pull request immediately to find releasable units.
-
-### Existing Pull Requests with "autorelease: pending" label
+Check existing pull requests labelled with `autorelease: pending` or
+`autorelease: triggered` label.
+Due to GitHub API failures, it's possible that the tag was not removed
+correctly upon a previous release and Release Please thinks that the previous release is
+still pending.
+If you're certain that there's no pending release, remove the
+`autorelease: pending` or `autorelease: triggered` label.
 
 For the GitHub application users, Release Please will not create a new pull request
 if there's an existing pull request labeled as `autorelease: pending`.
@@ -168,6 +168,14 @@ If you find a release pull request with the label and it is not going to be rele
 (or already released), then remove the `autorelease: pending` label and re-run Release
 Please.
 
+### Step 3: Rerun Release Please
+
+If you think Release Please missed creating a release PR after a pull request
+with a releasable unit has been merged, please re-run `release-please`. If you are using
+the GitHub application, add `release-please:force-run` label to the merged pull request. If
+you are using the action, look for the failed invocation and retry the workflow run.
+Release Please will process the pull request immediately to find releasable units.
+
 ## Strategy (Language) types supported
 
 Release Please automates releases for the following flavors of repositories:

diff --git a/docs/cli.md b/docs/cli.md
@@ -51,6 +51,7 @@ Extra options:
 | `--versioning-strategy` | [`VersioningStrategyType`](/docs/customizing.md#versioning-strategies) | Override method of determining SemVer version bumps based on commits. Defaults to `default` |
 | `--bump-minor-pre-major` | `boolean` | Configuration option for the versioning strategy. If set, will bump the minor version for breaking changes for versions < 1.0.0 |
 | `--bump-patch-for-minor-pre-major` | `boolean` | Configuration option for the versioning strategy. If set, will bump the patch version for features for versions < 1.0.0 |
+| `--prerelease-type` | `string` | Configuration option for the prerelese versioning strategy. If prerelease strategy used and type set, will set the prerelese part of the version to the provided value in case prerelease part is not present. |
 | `--draft` | `boolean` | If set, create releases as drafts |
 | `--prerelease` | `boolean` | If set, create releases that are pre-major or pre-release version marked as pre-release on Github|
 | `--draft-pull-request` | `boolean` | If set, create pull requests as drafts |
@@ -101,6 +102,7 @@ need to specify your release options:
 | `--versioning-strategy` | VersioningStrategy | Override method of determining SemVer version bumps based on commits. Defaults to `default` |
 | `--bump-minor-pre-major` | boolean | Configuration option for the versioning strategy. If set, will bump the minor version for breaking changes for versions < 1.0.0 |
 | `--bump-patch-for-minor-pre-major` | boolean | Configuration option for the versioning strategy. If set, will bump the patch version for features for versions < 1.0.0 |
+| `--prerelease-type` | `string` | Configuration option for the prerelese versioning strategy. If prerelease strategy used and type set, will set the prerelese part of the version to the provided value in case prerelease part is not present. |
 | `--draft-pull-request` | boolean | If set, create pull requests as drafts |
 | `--label` | string | Comma-separated list of labels to apply to the release pull requests. Defaults to `autorelease: pending` |`autorelease: tagged` |
 | `--changelog-path` | `string` | Override the path to the managed CHANGELOG. Defaults to `CHANGELOG.md` |

diff --git a/docs/customizing.md b/docs/customizing.md
@@ -45,6 +45,8 @@ version given a list of parsed commits.
 | `always-bump-major` | Always bump major version |                                                                                  
 | `service-pack`      | Designed for Java backport fixes. Uses Maven's specification for service pack versions (e.g. 1.2.3-sp.1)    |
 
+| `prerelease`      | Bumping prerelease number (eg. 1.2.0-beta01 to 1.2.0-beta02) or if prerelease type is set, using that in the prerelease part (eg. 1.2.1 to 1.3.0-beta)  |
+
 ### Adding additional versioning strategy types
 
 To add a new versioning strategy, create a new class that implements the
@@ -174,6 +176,8 @@ the block, we will attempt to replace version values.
 
 ## Updating arbitrary JSON files
 
+For files with the `.xml` extension, the `version` property is updated.
+
 For most release strategies, you can provide additional files to update
 using the [GenericJson](/src/updaters/generic-json.ts) updater. You can
 specify a configuration object in the `extra-files` option in the manifest
@@ -197,6 +201,8 @@ informs release-please on which JSON field to update with the new version.
 
 ## Updating arbitrary XML files
 
+For files with the `.xml` extension, the `version` element is updated.
+
 For most release strategies, you can provide additional files to update
 using the [GenericXml](/src/updaters/generic-xml.ts) updater. You can
 specify a configuration object in the `extra-files` option in the manifest
@@ -216,6 +222,9 @@ configuration.
 
 ## Updating arbitrary YAML files
 
+For files with the `.yaml` or `.yml` extension, the `version` property is
+updated.
+
 For most release strategies, you can provide additional files to update
 using the [GenericYaml](/src/updaters/generic-yaml.ts) updater. You can
 specify a configuration object in the `extra-files` option in the manifest
@@ -235,6 +244,8 @@ configuration.
 
 ## Updating arbitrary TOML files
 
+For files with the `.toml` extension, the `version` property is updated.
+
 For most release strategies, you can provide additional files to update
 using the [GenericToml](/src/updaters/generic-toml.ts) updater. You can
 specify a configuration object in the `extra-files` option in the manifest

diff --git a/docs/manifest-releaser.md b/docs/manifest-releaser.md
@@ -172,6 +172,9 @@ defaults (those are documented in comments)
   // absence defaults to false
   "bump-patch-for-minor-pre-major": true,
 
+  // setting the type of prerelease in case of prerelease strategy
+  "prerelease-type": true,
+
   // set default conventional commit => changelog sections mapping/appearance.
   // absence defaults to https://git.io/JqCZL
   "changelog-sections": [...],