actions-marketplace-validations/Update Pull Request from Branch Name
Updates a pull request with information extracted from head and/or base branch name
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| error-on-fail | Fail the PR Checks if there is any issues | no | true |
| repo-token | [REQUIRED] The GITHUB_TOKEN secret, which is needed to access the repository | yes | — |
| base-branch-regex | Regex to match text in the base branch name | no | "" |
| head-branch-regex | Regex to match text in the head branch name | no | "" |
| lowercase-branch | Should the action make the branch name lowercase internally before matching | no | true |
| title-template | Text to insert into the PR title. This is based on the matched text from `base-branch-regex` or `head-branch-regex`. You can use whatever text you like, along with the following tokens: %basebranch% | %headbranch% | no | "" |
| title-update-action | Action to perform on the title. Allowed values: prefix | suffix | replace | no | prefix |
| title-insert-space | Should the action insert a space between title and its prefix/suffix | no | true |
| title-uppercase-base-match | Should the matched text from base branch be in uppercase in the title | no | true |
| title-uppercase-head-match | Should the matched text from head branch be in uppercase in the title | no | true |
| body-template | Text to insert into the PR body. You can use whatever text you like, along with the following tokens: %basebranch% | %headbranch% | no | "" |
| body-update-action | Update action to perform on the body. Allowed values: prefix | suffix | replace | no | prefix |
| body-newline-count | Number of newlines to separate body and its prefix/suffix | no | 2 |
| body-uppercase-base-match | Should the matched text from base branch be in the body. This is a check and will not change anything. | no | true |
| body-uppercase-head-match | Should the matched text from head branch be in the body. This is a check and will not change anything. | no | true |
Outputs
| name | description |
|---|---|
| baseMatch | Matched text from base branch, if any |
| headMatch | Matched text from head branch, if any |
| titleUpdated | Whether the PR title was updated |
| bodyUpdated | Whether the PR body was updated |