Question 1

How do I set up pull-request-action for automated documentation updates?

Accepted Answer

Configure the action with a BRANCH_PREFIX like 'docs/' in your workflow YAML, set PULL_REQUEST_BODY to describe changes, and use GITHUB_TOKEN for authentication. Ensure your automation pushes to branches matching the prefix to trigger PRs.

Question 2

Can pull-request-action handle PRs to a different repository?

Accepted Answer

Yes, by setting PULL_REQUEST_REPOSITORY and providing a PULL_REQUEST_TOKEN (Personal Access Token) saved in encrypted secrets. This allows cross-repo workflows, such as contributing to upstream projects, as detailed in the README.

Question 3

What's the difference between pull-request-action and other auto-PR actions like peter-evans/create-pull-request?

Accepted Answer

Pull-request-action uses environment variables for configuration and focuses on updating existing PRs, while others often use YAML inputs and may have different features like auto-merging. Choose based on your preference for env-driven vs. input-driven setup.

Question 4

How to assign reviewers automatically with pull-request-action?

Accepted Answer

Set the PULL_REQUEST_REVIEWERS environment variable with a space-separated list of GitHub usernames. Ensure the GITHUB_TOKEN or PAT has permissions to add reviewers, as noted in the README for users with push access.

Question 5

What happens if a pull request already exists?

Accepted Answer

You can configure it to update the PR using PULL_REQUEST_UPDATE, pass silently with PASS_IF_EXISTS, or fail. This flexibility helps in workflows where branches are repeatedly pushed, like in automated registry updates.

Question 6

Is pull-request-action good for CI/CD pipelines with container builds?

Accepted Answer

Yes, it's designed for automated workflows, such as container registry updates where content is pushed to branches. The example use case in the README shows how it handles prefix-based branches for organizational registries.

Open or Update PR on Branch Push (with Branch Selection)

What is Open or Update PR on Branch Push (with Branch Selection)?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions