chore(main): release 0.1.1 (#8 )

feat(release): rename CI workflow to Release
docs(readme): update features list and examples intro
2026-02-19 09:06:42 +00:00 · 2023-05-08 01:53:50 +01:00 · 2023-05-08 01:51:38 +01:00 · 2023-05-08 01:46:41 +01:00 · 2023-05-08 01:26:42 +01:00 · 2023-05-08 01:25:23 +01:00
6 changed files with 79 additions and 39 deletions
--- a/.github/.release-please-manifest.json
+++ b/.github/.release-please-manifest.json
@@ -0,0 +1,3 @@
+{
+  ".": "0.1.1"
+}
--- a/.github/release-please-manifest.json
+++ b/.github/release-please-manifest.json
@@ -1,3 +0,0 @@
-{
-  ".": "0.0.4"
-}
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@@ -1,24 +1,21 @@
 ---
-name: CI
-on: push
+name: Release
+on:
+  push:
+    branches:
+      - main

 jobs:
  release-please:
    runs-on: ubuntu-latest
-    if: github.ref == 'refs/heads/main'
-    permissions:
-      contents: write
    steps:
      - uses: jimeh/release-please-manifest-action@main
        id: release
-        with:
-          app-id: ${{ secrets.RELEASE_BOT_APP_ID }}
-          private-key: ${{ secrets.RELEASE_BOT_PRIVATE_KEY }}
      - name: Create/update MAJOR tag
        if: ${{ steps.release.outputs.release_created }}
        uses: richardsimko/update-tag@v1
        with:
-          tag_name: v${{ steps.release.outputs.major }}.${{ steps.release.outputs.minor }}
+          tag_name: v${{ steps.release.outputs.major }}
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
      - name: Create/update MAJOR.MINOR tag
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,5 +1,43 @@
 # Changelog

+## [0.1.1](https://github.com/jimeh/release-please-manifest-action/compare/v0.1.0...v0.1.1) (2023-05-08)
+
+
+### Features
+
+* **release:** rename CI workflow to Release ([1139eae](https://github.com/jimeh/release-please-manifest-action/commit/1139eaec31e83556c1eb35a523ee76485efb9ab5))
+
+## [0.1.0](https://github.com/jimeh/release-please-manifest-action/compare/v0.0.6...v0.1.0) (2023-05-08)
+
+
+### ⚠ BREAKING CHANGES
+
+* **action:** Change default manifest path to `.github/.release-please-manifest.json`.
+
+### Features
+
+* **action:** change default manifest file path ([4d6baa6](https://github.com/jimeh/release-please-manifest-action/commit/4d6baa6f81afde8c72681281cc4f6a9f675b8dda))
+
+## [0.0.6](https://github.com/jimeh/release-please-manifest-action/compare/v0.0.5...v0.0.6) (2023-05-08)
+
+
+### Features
+
+* **release:** remove use of GitHub App ([b60e27b](https://github.com/jimeh/release-please-manifest-action/commit/b60e27befea7298731468ae0a66eff098c362d86))
+
+
+### Bug Fixes
+
+* **release:** attempt to fix release job permissions ([c2d8586](https://github.com/jimeh/release-please-manifest-action/commit/c2d85862fdd1bdcb9b7b10dcb3d35d3d60f4afc6))
+* **release:** remove permissions block ([04d3b1e](https://github.com/jimeh/release-please-manifest-action/commit/04d3b1edbb4c7bd5f1b63b6bb3f65ca738ee1e52))
+
+## [0.0.5](https://github.com/jimeh/release-please-manifest-action/compare/v0.0.4...v0.0.5) (2023-05-07)
+
+
+### Bug Fixes
+
+* **release:** actually tag MAJOR ([e012dc8](https://github.com/jimeh/release-please-manifest-action/commit/e012dc88b94fb4ce8433076d45479ee4d0ed01b2))
+
 ## [0.0.4](https://github.com/jimeh/release-please-manifest-action/compare/v0.0.3...v0.0.4) (2023-05-07)


--- a/README.md
+++ b/README.md
@@ -38,13 +38,18 @@ running [release-please][] in [manifest mode][].

 - Focuses on and only supports running release-please's manifest command.
 - Optionally supports having release-please authenticate as a GitHub App.
- By default places release-please config and manifest files within the
-  top-level `.github` directory instead of in the repository root:
-  - `.github/release-please-manifest.json`
-  - `.github/release-please-config.json`
+- Defaults to looking for release-please's config and manifest files within the
+  top-level `.github` directory instead of in the repository root.

 # Examples

+All examples assume you have placed your `release-please-config.json` and
+`.release-please-manifest.json` within the `.github` directory in the root of
+the repository.
+
+See release-please's [manifest-releaser][manifest mode] documentation for
+details about the config and manifest files.
+
 ## Basic (Actions Token)

 This example will have release-please authenticate using `secrets.GITHUB_TOKEN`
@@ -66,7 +71,7 @@ on: push
 jobs:
  release-please:
    runs-on: ubuntu-latest
-    if: github.ref == 'refs/heads/main' || github.ref == 'refs/heads/master'
+    if: github.ref == 'refs/heads/main'
    steps:
      - uses: jimeh/release-please-manifest-action@v0
 ```
@@ -81,14 +86,14 @@ on: push
 jobs:
  release-please:
    runs-on: ubuntu-latest
-    if: github.ref == 'refs/heads/main' || github.ref == 'refs/heads/master'
+    if: github.ref == 'refs/heads/main'
    steps:
      - uses: google-github-actions/release-please-action@v3
        id: release-please
        with:
          command: manifest
          config-file: .github/release-please-config.json
-          manifest-file: .github/release-please-manifest.json
+          manifest-file: .github/.release-please-manifest.json
 ```

 _Note: Outputs are not included in this equivalence example._
@@ -112,7 +117,7 @@ on: push
 jobs:
  release-please:
    runs-on: ubuntu-latest
-    if: github.ref == 'refs/heads/main' || github.ref == 'refs/heads/master'
+    if: github.ref == 'refs/heads/main'
    steps:
      - uses: jimeh/release-please-manifest-action@v0
        with:
@@ -129,7 +134,7 @@ on: push
 jobs:
  release-please:
    runs-on: ubuntu-latest
-    if: github.ref == 'refs/heads/main' || github.ref == 'refs/heads/master'
+    if: github.ref == 'refs/heads/main'
    steps:
      - uses: google-github-actions/release-please-action@v3
        id: release-please
@@ -137,7 +142,7 @@ jobs:
          token: ${{ secrets.RELEASE_PAT_TOKEN }}
          command: manifest
          config-file: .github/release-please-config.json
-          manifest-file: .github/release-please-manifest.json
+          manifest-file: .github/.release-please-manifest.json
 ```

 _Note: Outputs are not included in this equivalence example._
@@ -162,7 +167,7 @@ Below we assume you have already setup `RELEASE_BOT_APP_ID` and
 `RELEASE_BOT_PRIVATE_KEY` secrets in the repository or organization.

 To set the private key secret, it is easiest to base64 encode the contents of
-`*.pem` file you get from the GitHub App's configuration page. The base64
+the `*.pem` file you get from the GitHub App's configuration page. The base64
 encoded string should not have any line-breaks.

 <!-- x-release-please-start-major -->
@@ -172,7 +177,7 @@ on: push
 jobs:
  release-please:
    runs-on: ubuntu-latest
-    if: github.ref == 'refs/heads/main' || github.ref == 'refs/heads/master'
+    if: github.ref == 'refs/heads/main'
    steps:
      - uses: jimeh/release-please-manifest-action@v0
        with:
@@ -190,7 +195,7 @@ on: push
 jobs:
  release-please:
    runs-on: ubuntu-latest
-    if: github.ref == 'refs/heads/main' || github.ref == 'refs/heads/master'
+    if: github.ref == 'refs/heads/main'
    steps:
      - uses: tibdex/github-app-token@v1
        id: github-app-token
@@ -203,7 +208,7 @@ jobs:
          token: ${{ steps.github-app-token.outputs.token }}
          command: manifest
          config-file: .github/release-please-config.json
-          manifest-file: .github/release-please-manifest.json
+          manifest-file: .github/.release-please-manifest.json
 ```

 _Note: Outputs are not included in this equivalence example._
@@ -216,18 +221,18 @@ _Note: Outputs are not included in this equivalence example._

 ## Inputs

-| parameter       | description                                                                                                                                                                                      | required | default                              |
-| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------- | ------------------------------------ |
-| token           | GitHub token used to authenticate.                                                                                                                                                               | `false`  | ${{ github.token }}                  |
-| app-id          | ID of the GitHub App to use for authentication. If set, takes precedence over token input.                                                                                                       | `false`  |                                      |
-| private-key     | Private key of the GitHub App (can be Base64 encoded). Required when app-id is provided.                                                                                                         | `false`  |                                      |
-| installation-id | ID of the installation for which the app token will be requested. Defaults to the ID of the repository's installation.                                                                           | `false`  |                                      |
-| permissions     | JSON-stringified permissions granted to the app token. Defaults to all the GitHub app permissions, see: https://docs.github.com/en/rest/apps/apps#create-an-installation-access-token-for-an-app | `false`  |                                      |
-| github-api-url  | Configure github API URL.                                                                                                                                                                        | `false`  | ${{ github.api_url }}                |
-| repository      | The full name of the repository to operate on in owner/repo format. Defaults to the current repository.                                                                                          | `false`  | ${{ github.repository }}             |
-| default-branch  | Branch to open pull release PR against. Defaults to the repository's default branch.                                                                                                             | `false`  |                                      |
-| config-file     | Pat to config file within the project.                                                                                                                                                           | `false`  | .github/release-please-config.json   |
-| manifest-file   | Path to manifest file within the project.                                                                                                                                                        | `false`  | .github/release-please-manifest.json |
+| parameter       | description                                                                                                                                                                                      | required | default                               |
+| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------- | ------------------------------------- |
+| token           | GitHub token used to authenticate.                                                                                                                                                               | `false`  | ${{ github.token }}                   |
+| app-id          | ID of the GitHub App to use for authentication. If set, takes precedence over token input.                                                                                                       | `false`  |                                       |
+| private-key     | Private key of the GitHub App (can be Base64 encoded). Required when app-id is provided.                                                                                                         | `false`  |                                       |
+| installation-id | ID of the installation for which the app token will be requested. Defaults to the ID of the repository's installation.                                                                           | `false`  |                                       |
+| permissions     | JSON-stringified permissions granted to the app token. Defaults to all the GitHub app permissions, see: https://docs.github.com/en/rest/apps/apps#create-an-installation-access-token-for-an-app | `false`  |                                       |
+| github-api-url  | Configure github API URL.                                                                                                                                                                        | `false`  | ${{ github.api_url }}                 |
+| repository      | The full name of the repository to operate on in owner/repo format. Defaults to the current repository.                                                                                          | `false`  | ${{ github.repository }}              |
+| default-branch  | Branch to open pull release PR against. Defaults to the repository's default branch.                                                                                                             | `false`  |                                       |
+| config-file     | Pat to config file within the project.                                                                                                                                                           | `false`  | .github/release-please-config.json    |
+| manifest-file   | Path to manifest file within the project.                                                                                                                                                        | `false`  | .github/.release-please-manifest.json |

 <!-- action-docs-inputs -->

--- a/action.yml
+++ b/action.yml
@@ -52,7 +52,7 @@ inputs:
  manifest-file:
    description: Path to manifest file within the project.
    required: false
-    default: ".github/release-please-manifest.json"
+    default: ".github/.release-please-manifest.json"

 outputs:
  release_created:
Author	SHA1	Message	Date
github-actions[bot]	8ae0004991	chore(main): release 0.1.1 (#8 )	2023-05-08 01:53:50 +01:00
Jim Myhrberg	1139eaec31	feat(release): rename CI workflow to Release	2023-05-08 01:51:38 +01:00
Jim Myhrberg	48a1ac7188	docs(readme): update features list and examples intro	2023-05-08 01:46:41 +01:00
github-actions[bot]	5a9880757d	chore(main): release 0.1.0 (#7 )	2023-05-08 01:26:42 +01:00
Jim Myhrberg	9d21ba2763	chore(release): rename release-please manifest file	2023-05-08 01:25:23 +01:00
Jim Myhrberg	4d6baa6f81	feat(action)!: change default manifest file path Brings this action more inline with the upstream action, by keeping the config and manifest filenames identical, and simply moving them into the ".github" directory. BREAKING CHANGE: Change default manifest path to `.github/.release-please-manifest.json`.	2023-05-08 01:22:13 +01:00
github-actions[bot]	1d94b44003	chore(main): release 0.0.6 (#6 )	2023-05-08 01:14:05 +01:00
Jim Myhrberg	8634e410ba	docs(readme): remove permissions directive from examples	2023-05-08 01:10:40 +01:00
Jim Myhrberg	04d3b1edbb	fix(release): remove permissions block Instead lets set permissions in repository settings and see if that works without the permissions settings in the workflow.	2023-05-08 01:07:55 +01:00
Jim Myhrberg	c2d85862fd	fix(release): attempt to fix release job permissions It seems the "pull-request: write" permission on the job did not work. So we are now setting permissions at the workflow level	2023-05-08 01:06:44 +01:00
Jim Myhrberg	b60e27befe	feat(release): remove use of GitHub App We don't currently have any CI checks to run on pull requests, so there's no need to author Release PRs from an app.	2023-05-08 00:57:10 +01:00
Jim Myhrberg	a056b80ec3	docs(readme): update examples	2023-05-08 00:57:10 +01:00
jimehbot[bot]	4205a83fff	chore(main): release 0.0.5 (#5 )	2023-05-08 00:47:43 +01:00
Jim Myhrberg	e012dc88b9	fix(release): actually tag MAJOR	2023-05-08 00:44:56 +01:00