basetenlabs/create-pull-request

basetenlabs/create-pull-request

Description: A GitHub action to create a pull request for changes to your repository in the actions workspace

License: MIT

Stars: 0

Forks: 0

Open issues: 3

Created: 2025-03-26T17:00:39Z

Pushed: 2026-01-14T21:55:31Z

Default branch: main

Fork: yes

Parent repository: peter-evans/create-pull-request

Archived: no

README:

Create Pull Request


A GitHub action to create a pull request for changes to your repository in the actions workspace.

Changes to a repository in the Actions workspace persist between steps in a workflow. This action is designed to be used in conjunction with other steps that modify or add files to your repository. The changes will be automatically committed to a new branch and a pull request created.

Create Pull Request action will:

1. Check for repository changes in the Actions workspace. This includes:

• untracked (new) files
• tracked (modified) files
• commits made during the workflow that have not been pushed

2. Commit all changes to a new branch, or update an existing pull request branch. 3. Create or update a pull request to merge the branch into the base—the branch checked out in the workflow.

Documentation

• [Concepts, guidelines and advanced usage](docs/concepts-guidelines.md)
• [Examples](docs/examples.md)
• [Updating to v7](docs/updating.md)
• [Common issues](docs/common-issues.md)

Usage

- uses: actions/checkout@v4

# Make changes to pull request here

- name: Create Pull Request
uses: peter-evans/create-pull-request@v7

You can also pin to a specific release version in the format @v7.x.x

Workflow permissions

For this action to work you must explicitly allow GitHub Actions to create pull requests. This setting can be found in a repository's settings under Actions > General > Workflow permissions.

For repositories belonging to an organization, this setting can be managed by admins in organization settings under Actions > General > Workflow permissions.

Action inputs

All inputs are optional. If not set, sensible defaults will be used.

| Name | Description | Default | | --- | --- | --- | | token | The token that the action will use to create and update the pull request. See [token](#token). | GITHUB_TOKEN | | branch-token | The token that the action will use to create and update the branch. See [branch-token](#branch-token). | Defaults to the value of token | | path | Relative path under GITHUB_WORKSPACE to the repository. | GITHUB_WORKSPACE | | add-paths | A comma or newline-separated list of file paths to commit. Paths should follow git's pathspec syntax. If no paths are specified, all new and modified files are added. See [Add specific paths](#add-specific-paths). | | | commit-message | The message to use when committing changes. See [commit-message](#commit-message). | [create-pull-request] automated change | | committer | The committer name and email address in the format Display Name . Defaults to the GitHub Actions bot user on github.com. | github-actions[bot] | | author | The author name and email address in the format Display Name . Defaults to the user who triggered the workflow run. | ${{ github.actor }} | | 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. See [delete-branch](#delete-branch). | false | | branch-suffix | The branch suffix type when using the alternative branching strategy. Valid values are random, timestamp and short-commit-hash. See [Alternative strategy](#alternative-strategy---always-create-a-new-pull-request-branch) for details. | | | base | Sets 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. See [push pull request branches to a fork](docs/concepts-guidelines.md#push-pull-request-branches-to-a-fork) for details. | | | sign-commits | Sign commits as github-actions[bot] when using GITHUB_TOKEN, or your own bot when using [GitHub App tokens](docs/concepts-guidelines.md#authenticating-with-github-app-generated-tokens). See [commit signing](docs/concepts-guidelines.md#commit-signature-verification-for-bots) for details. | 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 PAT, or equivalent [GitHub App permissions](docs/concepts-guidelines.md#authenticating-with-github-app-generated-tokens), are required. | | | milestone | The number of the milestone to associate this 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…