canonical/Create Pull Request
Create a pull request from local changes.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| github-token | The GitHub token required to perform actions such as pushing commits and creating pull requests. | yes | — |
| base | The base branch to create the pull request against. Defaults to the current `github.ref` context if not set. The git reference for the base must exists locally (i.e. "fetched"). | no | — |
| branch-name | The name of the new branch to be created by this action. | yes | — |
| commit-message | The commit message for the new commit created by this action. | yes | — |
| title | The title of the pull request that will be created. | yes | — |
| body | The body content of the pull request. This can provide additional information or context for the changes being made. | no | — |
| upsert | When enabled, updates the existing branch and pull request instead of failing. | no | false |
| ignore-no-changes | When enabled, the action will ignore the absence of local changes and exit without raising an error. | no | false |
| auto-merge | When enabled, the action will enable auto-merge using the squash merge method for the pull request and delete the branch after merge. | no | false |
| repository | The repository to create the branch and pull request on, for example `canonical/create-pull-request`. Defaults to the current repository if not set. | no | — |
Outputs
no outputs