chore(main): release 1.0.3 (#19)

Co-authored-by: jimehbot[bot] <132453784+jimehbot[bot]@users.noreply.github.com>

.github/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "1.0.3"
+}

.github/release-please-config.json

@@ -9,8 +9,7 @@
       "bump-minor-pre-major": true,
       "bump-patch-for-minor-pre-major": true,
       "draft": false,
-      "prerelease": false,
+      "prerelease": false
-      "initial-version": "0.0.1"
     }
   },
   "$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json"

.github/release-please-manifest.json

@@ -1,3 +0,0 @@
-{
-  ".": "0.0.2"
-}

.github/workflows/ci.yml

@@ -1,36 +1,34 @@
 ---
-name: CI
+name: Release
 on: push
 
 jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16
+      - run: make docs
+      - name: Verify no changes after docs build
+        run: |
+          git diff --exit-code
+
   release-please:
     runs-on: ubuntu-latest
     if: github.ref == 'refs/heads/main'
-    permissions:
-      contents: write
     steps:
+      # TOOD: Switch back to @v1 once once v1.0.3 is released.
       - uses: jimeh/release-please-manifest-action@main
         id: release
         with:
           app-id: ${{ secrets.RELEASE_BOT_APP_ID }}
           private-key: ${{ secrets.RELEASE_BOT_PRIVATE_KEY }}
-      - uses: actions/checkout@v3
+      - name: MAJOR and MAJOR.MINOR tags
         if: ${{ steps.release.outputs.release_created }}
-      - name: Tag major and minor versions
+        uses: jimeh/update-tags-action@v1
-        if: ${{ steps.release.outputs.release_created }}
+        with:
-        run: |
+          tags: |
-          git config user.name 'jimehbot[bot]'
+            v${{ steps.release.outputs.major }}
-          git config user.email '132453784+jimehbot[bot]@users.noreply.github.com'
+            v${{ steps.release.outputs.major }}.${{ steps.release.outputs.minor }}
-          git remote add gh-token "https://${GITHUB_TOKEN}@github.com/${{ github.repository }}.git"
-          git tag -d "$MAJOR_TAG" || true
-          git tag -d "$MINOR_TAG" || true
-          git push origin ":${MAJOR_TAG}" || true
-          git push origin ":${MINOR_TAG}" || true
-          git tag -a "$MAJOR_TAG" -m "Release ${MAJOR_TAG}"
-          git tag -a "$MINOR_TAG" -m "Release ${MINOR_TAG}"
-          git push origin "$MAJOR_TAG"
-          git push origin "$MINOR_TAG"
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN}}
-          MAJOR_TAG: v${{ steps.release.outputs.major }}
-          MINOR_TAG: v${{ steps.release.outputs.major }}.${{ steps.release.outputs.minor }}

CHANGELOG.md

@@ -1,5 +1,85 @@
 # Changelog
 
+## [1.0.3](https://github.com/jimeh/release-please-manifest-action/compare/v1.0.2...v1.0.3) (2024-05-13)
+
+
+### Bug Fixes
+
+* **deps:** use new name for Google's release please action ([#18](https://github.com/jimeh/release-please-manifest-action/issues/18)) ([72e49f5](https://github.com/jimeh/release-please-manifest-action/commit/72e49f5d6f009b0e0c4faff0c835703ee9ee3093))
+
+## [1.0.2](https://github.com/jimeh/release-please-manifest-action/compare/v1.0.1...v1.0.2) (2023-05-18)
+
+
+### Bug Fixes
+
+* **action:** correct minor typo in action metadata ([#14](https://github.com/jimeh/release-please-manifest-action/issues/14)) ([f307f17](https://github.com/jimeh/release-please-manifest-action/commit/f307f175b93d8eb1a1a4dfaf9092efaba72a6d62))
+
+## [1.0.1](https://github.com/jimeh/release-please-manifest-action/compare/v1.0.0...v1.0.1) (2023-05-08)
+
+
+### Bug Fixes
+
+* **action:** set correct action name in action.yml metadata ([#10](https://github.com/jimeh/release-please-manifest-action/issues/10)) ([322dcdf](https://github.com/jimeh/release-please-manifest-action/commit/322dcdf56ed8be4589ffbd70cb1382198ca65120))
+
+## [1.0.0](https://github.com/jimeh/release-please-manifest-action/compare/v0.1.1...v1.0.0) (2023-05-08)
+
+
+### Features
+
+* **release:** prepare for v1.0.0 ([22f0022](https://github.com/jimeh/release-please-manifest-action/commit/22f0022a0932f5639bb4808df16e76c245256880))
+
+## [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)
+
+
+### Bug Fixes
+
+* **release:** attempt to sign major and minor tags ([77312c1](https://github.com/jimeh/release-please-manifest-action/commit/77312c11a926651d7f66d4fed3dcd5d0b50727ae))
+
+## [0.0.3](https://github.com/jimeh/release-please-manifest-action/compare/v0.0.2...v0.0.3) (2023-05-07)
+
+
+### Bug Fixes
+
+* **release:** use full version in tag annotations ([08e227b](https://github.com/jimeh/release-please-manifest-action/commit/08e227b3057a732f0947407b8657123e5418e77c))
+
 ## [0.0.2](https://github.com/jimeh/release-please-manifest-action/compare/v0.0.1...v0.0.2) (2023-05-07)
 
 

Makefile

@@ -1,3 +1,10 @@
+.PHONY: docs
+docs: readme
+
+.PHONY: readme
+readme: check-npx action-docs
+	npx --yes prettier --print-width 80 --prose-wrap always --write README.md
+
 .PHONY: action-docs
 action-docs: check-npx
 	npx --yes action-docs --update-readme

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
+- Defaults to looking for release-please's config and manifest files within the
-  top-level `.github` directory instead of in the repository root:
+  top-level `.github` directory instead of in the repository root.
-  - `.github/release-please-manifest.json`
-  - `.github/release-please-config.json`
 
 # 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,9 +71,9 @@ 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
+      - uses: jimeh/release-please-manifest-action@v1
 ```
 
 <!-- x-release-please-end -->
@@ -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,9 +117,9 @@ 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
+      - uses: jimeh/release-please-manifest-action@v1
         with:
           token: ${{ secrets.RELEASE_PAT_TOKEN }}
 ```
@@ -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,9 +177,9 @@ 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
+      - uses: jimeh/release-please-manifest-action@v1
         with:
           app-id: ${{ secrets.RELEASE_BOT_APP_ID }}
           private-key: ${{ secrets.RELEASE_BOT_PRIVATE_KEY }}
@@ -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                              |
+| parameter       | description                                                                                                                                                                                      | required | default                               |
-| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------- | ------------------------------------ |
+| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------- | ------------------------------------- |
-| token           | GitHub token used to authenticate.                                                                                                                                                               | `false`  | ${{ github.token }}                  |
+| 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`  |                                      |
+| 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`  |                                      |
+| 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`  |                                      |
+| 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`  |                                      |
+| 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 }}                |
+| 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 }}             |
+| 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`  |                                      |
+| 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   |
+| 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 |
+| manifest-file   | Path to manifest file within the project.                                                                                                                                                        | `false`  | .github/.release-please-manifest.json |
 
 <!-- action-docs-inputs -->
 
@@ -242,7 +247,7 @@ _Note: Outputs are not included in this equivalence example._
 | id               | Release ID.                                              |
 | name             | Release name.                                            |
 | tag_name         | Release tag name.                                        |
-| sha              | Release sha                                              |
+| sha              | Release SHA.                                             |
 | body             | Release body.                                            |
 | html_url         | Release URL.                                             |
 | draft            | Whether or not the release is a draft.                   |

action.yml

@@ -1,5 +1,5 @@
 ---
-name: "release-please-action"
+name: "release-please-manifest-action"
 description: >-
   Opinionated action for running release-please in manifest mode with optional
   support to authenticate as a GitHub App.
@@ -7,8 +7,7 @@ author: "jimeh"
 
 inputs:
   token:
-    description: >-
+    description: "GitHub token used to authenticate."
-      GitHub token used to authenticate.
     required: false
     default: ${{ github.token }}
   app-id:
@@ -52,7 +51,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:
@@ -71,7 +70,7 @@ outputs:
     description: "Release tag name."
     value: ${{ steps.release-please.outputs.tag_name }}
   sha:
-    description: "Release sha"
+    description: "Release SHA."
     value: ${{ steps.release-please.outputs.sha }}
   body:
     description: "Release body."
@@ -126,7 +125,7 @@ runs:
         permissions: ${{ inputs.permissions }}
         private_key: ${{ inputs.private-key }}
         repository: ${{ github.repository }}
-    - name: Determine which token to use
+    - name: resolve token
       id: token
       run: |-
         echo "token=${APP_TOKEN:-$INPUT_TOKEN}" >> "$GITHUB_OUTPUT"
@@ -134,7 +133,7 @@ runs:
         APP_TOKEN: "${{ steps.github-app-token.outputs.token }}"
         INPUT_TOKEN: "${{ inputs.token }}"
       shell: bash
-    - uses: google-github-actions/release-please-action@v3
+    - uses: googleapis/release-please-action@v3
       id: release-please
       with:
         command: manifest