actions-marketplace-validations/Create Pull Request
Creates a pull request for changes to your repository in the actions workspace
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Activelast commit May 1, 2026
- License
- MIT
Pinned Snippet
uses: actions-marketplace-validations/peter-evans_create-pull-request@d8c15c739ffb916295c3e41a2e70c38504c0f6dc # no releases — HEAD as of 2026-07-13tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| token | The token that the action will use to create and update the pull request. | — | ${{ github.token }} |
| branch-token | The token that the action will use to create and update the branch. Defaults to the value of `token`. | — | — |
| path | Relative path under $GITHUB_WORKSPACE to the repository. Defaults to $GITHUB_WORKSPACE. | — | — |
| add-paths | A comma or newline-separated list of file paths to commit. Paths should follow git's pathspec syntax. Defaults to adding all new and modified files. | — | — |
| commit-message | The message to use when committing changes. | — | [create-pull-request] automated change |
| committer | The committer name and email address in the format `Display Name <email@address.com>`. Defaults to the GitHub Actions bot user. | — | github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> |
| author | The author name and email address in the format `Display Name <email@address.com>`. Defaults to the user who triggered the workflow run. | — | ${{ github.actor }} <${{ github.actor_id }}+${{ github.actor }}@users.noreply.github.com> |
| signoff | Add `Signed-off-by` line by the committer at the end of the commit log message. | — | false |
| branch | The pull request branch name. | — | create-pull-request/patch |
| delete-branch | Delete the `branch` if it doesn't have an active pull request associated with it. | — | false |
| branch-suffix | The branch suffix type when using the alternative branching strategy. | — | — |
| base | The pull request base branch. Defaults to the branch checked out in the workflow. | — | — |
| push-to-fork | A fork of the checked out parent repository to which the pull request branch will be pushed. e.g. `owner/repo-fork`. The pull request will be created to merge the fork's branch into the parent's base. | — | — |
| sign-commits | Sign commits as `github-actions[bot]` when using `GITHUB_TOKEN`, or your own bot when using GitHub App tokens. | — | false |
| title | The title of the pull request. | — | Changes by create-pull-request action |
| body | The body of the pull request. | — | Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action |
| body-path | The path to a file containing the pull request body. Takes precedence over `body`. | — | — |
| labels | A comma or newline separated list of labels. | — | — |
| assignees | A comma or newline separated list of assignees (GitHub usernames). | — | — |
| reviewers | A comma or newline separated list of reviewers (GitHub usernames) to request a review from. | — | — |
| team-reviewers | A comma or newline separated list of GitHub teams to request a review from. Note that a `repo` scoped Personal Access Token (PAT) may be required. | — | — |
| milestone | The number of the milestone to associate the pull request with. | — | — |
| draft | Create a draft pull request. Valid values are `true` (only on create), `always-true` (on create and update), and `false`. | — | false |
| maintainer-can-modify | Indicates whether maintainers can modify the pull request. | — | true |
Outputs
| name | description |
|---|---|
| pull-request-number | The pull request number |
| pull-request-url | The URL of the pull request. |
| pull-request-operation | The pull request operation performed by the action, `created`, `updated` or `closed`. |
| pull-request-head-sha | The commit SHA of the pull request branch. |
| pull-request-branch | The pull request branch name |