Automatically merge PRs That Are Ready
A GitHub Action that automatically merges pull requests when they meet configured criteria like required approvals and passing checks.
What is Automatically merge PRs That Are Ready?
automerge-action is a GitHub Action that automatically merges pull requests when they are ready, based on configurable criteria like required labels, passing status checks, and approval reviews. It solves the problem of manual merge coordination in team-based development by automating the process once all conditions are met.
Development teams using GitHub for collaborative software projects who want to automate their pull request merge workflows and reduce manual overhead.
Developers choose automerge-action for its deep integration with GitHub's branch protection rules, high configurability (labels, merge methods, retries), and reliability in handling complex merge scenarios, offering more control than GitHub's native auto-merge for advanced workflows.
Overview
GitHub action to automatically merge pull requests that are ready
Use Cases
Best For
- Automating merge workflows for teams with strict code review requirements
- Reducing manual intervention in CI/CD pipelines after checks pass
- Enforcing label-based merge policies (e.g., 'automerge' label required)
- Handling rebase or squash merges automatically based on PR labels
- Managing pull requests from forks in open-source projects
- Implementing retry logic for merges when status checks are delayed
Not Ideal For
- Teams using GitHub's native auto-merge for straightforward squash or merge workflows without rebasing needs
- Projects where merged pull requests must automatically trigger subsequent GitHub Actions workflows
- Organizations with minimal DevOps expertise that prefer out-of-the-box, low-configuration solutions
Pros & Cons
Pros
Allows precise triggering with configurable labels, including blocking labels prefixed with '!', as detailed in the MERGE_LABELS option for complex merge policies.
Automatically respects GitHub's required status checks and approvals, ensuring merges only proceed when all repository rules are satisfied, as emphasized in the README.
Supports merge, rebase, and squash for both merging and updating PRs, configurable via labels or global settings like MERGE_METHOD and UPDATE_METHOD.
Can handle pull requests from forked repositories with the MERGE_FORKS option, making it suitable for open-source projects, as noted in the Configuration section.
Cons
Merges performed by this action do not trigger other GitHub Actions workflows by default, requiring complex workarounds with personal access tokens, as admitted in the Limitations section.
Involves setting numerous environment variables and understanding event triggers, which can be error-prone and time-consuming compared to simpler alternatives.
With GitHub's built-in auto-merge now available, this action adds unnecessary overhead for teams not requiring advanced features like rebasing or label-based merge methods, as the README acknowledges.
Frequently Asked Questions
Related Projects
Create a PR for Changes to your Repository in the Actions WorkspaceA GitHub action to create a pull request for changes to your repository in the actions workspace
Automatically Bump and Tag on MergeA Github Action to tag a repo on merge.
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.