Question 1

How do I use a personal access token with create-pull-request?

Accepted Answer

Set the 'token' input to your PAT secret stored in GitHub Secrets. For classic PATs, use 'repo' scope; for fine-grained PATs, ensure 'contents: write' and 'pull-requests: write' scopes, as specified in the documentation.

Question 2

Create pull request action vs Dependabot: which is better for dependency updates?

Accepted Answer

Create Pull Request is more flexible for custom automated changes like code generation, while Dependabot is built specifically for dependency updates with built-in version analysis. Use this action if you need control over the update process or other types of changes.

Question 3

How to update an existing PR with new changes using this action?

Accepted Answer

By default, it updates the same branch specified in the 'branch' input. New changes in the workspace will be committed to that branch and reflected in the open pull request automatically, as described in the action behavior.

Question 4

Can create-pull-request action sign commits?

Accepted Answer

Yes, set the 'sign-commits' input to true. With GITHUB_TOKEN, it signs as github-actions[bot]; with GitHub App tokens, it uses your bot's signature for verified commits, as detailed in the commit signing section.

Question 5

How to filter which files are committed in create-pull-request?

Accepted Answer

Use the 'add-paths' input with git pathspec syntax to include specific files, or remove unwanted files in a previous step. The action also respects .gitignore files, giving multiple ways to control committed content.

Question 6

What permissions are needed for create-pull-request to work correctly?

Accepted Answer

In repository settings, enable GitHub Actions to create pull requests. In the workflow file, elevate GITHUB_TOKEN permissions to 'contents: write' and 'pull-requests: write' if needed, as newer repositories default to read-only.

Create a PR for Changes to your Repository in the Actions Workspace

What is Create a PR for Changes to your Repository in the Actions Workspace?

Overview

Use Cases

Best For

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions