krystal/release-please-manifest-action
Opinionated action for running release-please in manifest mode with optional support to authenticate as a GitHub App.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| token | GitHub token used to authenticate. | — | ${{ github.token }} |
| client-id | Client ID of the GitHub App to use for authentication. If set, takes precedence over app-id and token inputs. | — | — |
| app-id | ID of the GitHub App to use for authentication. Deprecated in favor of client-id. Used only when client-id is not set. | — | — |
| private-key | Private key of the GitHub App (can be Base64 encoded). Required when client-id or app-id is provided. | — | — |
| target-branch | Branch to open pull release PR against. Defaults to the repository's default branch. | — | "" |
| target-branch-pattern | Regular expression pattern to determine if current ref name is a target branch or not. When specified, the action will only run if the current ref name matches the pattern, and the current ref name will be used as the target branch. When not specified, the action will always run, and target the specified target-branch, or the repository's default branch if target-branch is not specified. | — | "" |
| config-file | Path to config file within the project. | — | .github/release-please-config.json |
| manifest-file | Path to manifest file within the project. | — | .github/.release-please-manifest.json |
Outputs
| name | description |
|---|---|
| release_created | Whether or not a release was created. |
| upload_url | Release upload URL. |
| html_url | Release URL. |
| tag_name | Release tag name. |
| version | Version that was released. |
| major | Major version that was released. |
| minor | Minor version that was released. |
| patch | Patch version that was released. |
| sha | Release SHA. |
| pr | Pull request number. |
| path | Path that was released. |
| releases_created | Whether or not a release was created. |
| paths_released | Paths that were released. |
| id | Release ID. |
| name | Release name. |
| body | Release body. |
| draft | Whether or not the release is a draft. |
| prs_created | Whether or not a pull request was created. |
| pr_number | Pull request number that created the release. |
| prs | Pull request numbers. |
| raw | All outputs from release-please action as a JSON string. |