jimeh/release-please-manifest-action
1
0
Fork 0
mirror of https://github.com/jimeh/release-please-manifest-action.git synced 2026-02-19 09:06:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

Compare commits

base: jimeh:v2
Branches Tags
jimeh:main jimeh:upgrade-actions jimeh:reusable-workflow
jimeh:v3 jimeh:v3.0 jimeh:v3.0.0 jimeh:v2 jimeh:v2.0 jimeh:v2.0.0 jimeh:v1.0.3 jimeh:v1.0 jimeh:v1.0.2 jimeh:v1 jimeh:v1.0.1 jimeh:v1.0.0 jimeh:v0.1.1 jimeh:v0 jimeh:v0.1 jimeh:v0.1.0 jimeh:v0.0 jimeh:v0.0.6 jimeh:v0.0.5 jimeh:v0.0.4 jimeh:v0.0.3 jimeh:v0.0.2 jimeh:v0.0.1
...
compare: jimeh:upgrade-actions
Branches Tags
jimeh:main jimeh:upgrade-actions jimeh:reusable-workflow
jimeh:v3 jimeh:v3.0 jimeh:v3.0.0 jimeh:v2 jimeh:v2.0 jimeh:v2.0.0 jimeh:v1.0.3 jimeh:v1.0 jimeh:v1.0.2 jimeh:v1 jimeh:v1.0.1 jimeh:v1.0.0 jimeh:v0.1.1 jimeh:v0 jimeh:v0.1 jimeh:v0.1.0 jimeh:v0.0 jimeh:v0.0.6 jimeh:v0.0.5 jimeh:v0.0.4 jimeh:v0.0.3 jimeh:v0.0.2 jimeh:v0.0.1

1 Commits
v2 ... upgrade-ac

Author SHA1 Message Date
Jim Myhrberg
0cdb51c5bb chore(deps)!: upgrade dependant actions to new major versions 
This upgrades `tibdex/github-app-token` to `v2` and
`google-github-actions/release-please-action` to `v4`.

Among other things, this ensures that we are compatible with the GitHub
Actions upgrade to Node 20, and avoiding issues when Node 16-based
actions are deprecated sometime this spring.

BREAKING CHANGE: Underlying actions have been upgraded, requiring changes to available inputs
 2024-02-26 19:31:44 +00:00
2 changed files with 55 additions and 36 deletions
Expand all files Collapse all files

27
README.md
View File

@@ -221,18 +221,21 @@ _Note: Outputs are not included in this equivalence example._
## Inputs ## 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-retrieval-mode | The mode used to retrieve the installation for which the token will be requested. Must be one of: id, organization, repository, or user. For details see: https://github.com/tibdex/github-app-token | `false` | repository |
| 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` | | | installation-retrieval-payload | The payload used to retrieve the installation. | `false` | ${{ github.repository }} |
| github-api-url | Configure github API URL. | `false` | ${{ github.api_url }} | | 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` | |
| repository | The full name of the repository to operate on in owner/repo format. Defaults to the current repository. | `false` | ${{ github.repository }} | | github-api-url | Configure github API URL. | `false` | ${{ github.api_url }} |
| default-branch | Branch to open pull release PR against. Defaults to the repository's default branch. | `false` | | | target-branch | branch to open pull release PR against (detected by default) | `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 |
| path | create a release from a path other than the repository's root | `false` | |
| fork | If true, send the PR from a fork. This requires the token to be a user that can create forks (e.g. not the default GITHUB_TOKEN) | `false` | false |
| proxy-server | Set proxy sever when you run this action behind a proxy. Format is host:port e.g. proxy-host.com:8080 | `false` | |
<!-- action-docs-inputs --> <!-- action-docs-inputs -->

64
action.yml
View File

@@ -4,12 +4,11 @@ description: >-
Opinionated action for running release-please in manifest mode with optional Opinionated action for running release-please in manifest mode with optional
support to authenticate as a GitHub App. support to authenticate as a GitHub App.
author: "jimeh" author: "jimeh"
inputs: inputs:
token: token:
description: "GitHub token used to authenticate." description: "GitHub token used to authenticate."
required: false required: false
default: ${{ github.token }} default: "${{ github.token }}"
app-id: app-id:
description: >- description: >-
ID of the GitHub App to use for authentication. If set, takes precedence ID of the GitHub App to use for authentication. If set, takes precedence
@@ -20,38 +19,53 @@ inputs:
Private key of the GitHub App (can be Base64 encoded). Required when Private key of the GitHub App (can be Base64 encoded). Required when
app-id is provided. app-id is provided.
required: false required: false
installation-id: installation-retrieval-mode:
description: >- description: >-
ID of the installation for which the app token will be requested. Defaults The mode used to retrieve the installation for which the token will be
to the ID of the repository's installation. requested. Must be one of: id, organization, repository, or user. For
details see: https://github.com/tibdex/github-app-token
default: "repository"
installation-retrieval-payload:
description: "The payload used to retrieve the installation."
default: "${{ github.repository }}"
permissions: permissions:
description: >- description: >-
JSON-stringified permissions granted to the app token. Defaults to all the JSON-stringified permissions granted to the app token. Defaults to all the
GitHub app permissions, see: GitHub app permissions, see:
https://docs.github.com/en/rest/apps/apps#create-an-installation-access-token-for-an-app https://docs.github.com/en/rest/apps/apps#create-an-installation-access-token-for-an-app
github-api-url: github-api-url:
description: Configure github API URL. description: "Configure github API URL."
required: false required: false
default: ${{ github.api_url }} default: "${{ github.api_url }}"
repository: target-branch:
description: >- description: "Branch to open pull release PR against (detected by default)"
The full name of the repository to operate on in owner/repo format.
Defaults to the current repository.
default: ${{ github.repository }}
default-branch:
description: >-
Branch to open pull release PR against. Defaults to the repository's
default branch.
required: false required: false
default: "" default: ""
config-file: config-file:
description: Pat to config file within the project. description: "Pat to config file within the project."
required: false required: false
default: ".github/release-please-config.json" default: ".github/release-please-config.json"
manifest-file: manifest-file:
description: Path to manifest file within the project. description: "Path to manifest file within the project."
required: false required: false
default: ".github/.release-please-manifest.json" default: ".github/.release-please-manifest.json"
path:
description: >-
Create a release from a path other than the repository's root.
required: false
default: ""
fork:
description: >-
If true, send the PR from a fork. This requires the token to be a user
that can create forks (e.g. not the default GITHUB_TOKEN)
required: false
default: "false"
proxy-server:
description: >-
Set proxy sever when you run this action behind a proxy. Format is
host:port e.g. proxy-host.com:8080
required: false
default: ""
outputs: outputs:
release_created: release_created:
@@ -115,16 +129,16 @@ outputs:
runs: runs:
using: "composite" using: "composite"
steps: steps:
- uses: tibdex/github-app-token@v1 - uses: tibdex/github-app-token@v2
if: inputs.app-id != null && inputs.app-id != '' if: inputs.app-id != null && inputs.app-id != ''
id: github-app-token id: github-app-token
with: with:
app_id: ${{ inputs.app-id }} app_id: ${{ inputs.app-id }}
installation_id: ${{ inputs.installation-id }} installation_retrieval_mode: ${{ inputs.installation-retrieval-mode }}
installation_retrieval_payload: ${{ inputs.installation-retrieval-payload }}
github_api_url: ${{ inputs.github-api-url }} github_api_url: ${{ inputs.github-api-url }}
permissions: ${{ inputs.permissions }} permissions: ${{ inputs.permissions }}
private_key: ${{ inputs.private-key }} private_key: ${{ inputs.private-key }}
repository: ${{ github.repository }}
- name: resolve token - name: resolve token
id: token id: token
run: |- run: |-
@@ -133,14 +147,16 @@ runs:
APP_TOKEN: "${{ steps.github-app-token.outputs.token }}" APP_TOKEN: "${{ steps.github-app-token.outputs.token }}"
INPUT_TOKEN: "${{ inputs.token }}" INPUT_TOKEN: "${{ inputs.token }}"
shell: bash shell: bash
- uses: google-github-actions/release-please-action@v3 - uses: google-github-actions/release-please-action@v4
id: release-please id: release-please
with: with:
command: manifest
token: ${{ steps.token.outputs.token }} token: ${{ steps.token.outputs.token }}
default-branch: ${{ inputs.default-branch }} target-branch: ${{ inputs.target-branch }}
path: ${{ inputs.path }}
config-file: ${{ inputs.config-file }} config-file: ${{ inputs.config-file }}
manifest-file: ${{ inputs.manifest-file }} manifest-file: ${{ inputs.manifest-file }}
github-api-url: ${{ inputs.github-api-url }} github-api-url: ${{ inputs.github-api-url }}
github-graphql-url: ${{ inputs.github-api-url }} github-graphql-url: ${{ inputs.github-api-url }}
repo-url: ${{ inputs.repository }} repo-url: ${{ inputs.repository }}
fork: ${{ inputs.fork }}
proxy-server: ${{ inputs.proxy-server }}