README
¶
ghprmerge
A command-line tool to automatically evaluate, merge, and optionally rebase GitHub pull requests sharing the same source branch across an organization.
Use case: merging automated dependency update pull requests (e.g., Dependabot) without requiring clicking through each repository individually.
Quick Start
# Set your GitHub token
export GITHUB_TOKEN=ghp_xxxxxxxxxxxx
# Check version
ghprmerge --version
# Analyze what would be merged (default mode)
ghprmerge --org myorg --source-branch dependabot/
# Rebase out-of-date branches
ghprmerge --org myorg --source-branch dependabot/ --rebase
# Merge ready PRs (that are already up-to-date)
ghprmerge --org myorg --source-branch dependabot/ --merge
# Merge PRs even if behind (skip rebase requirement)
ghprmerge --org myorg --source-branch dependabot/ --merge --skip-rebase
# Use --confirm to review before taking actions
ghprmerge --org myorg --source-branch dependabot/ --rebase --confirm
Documentation
- Purpose & Philosophy - Design goals and safety model
- Usage Guide - Complete command-line reference
- Examples - Practical workflows
- Installation - Installation instructions
License
MIT License - see LICENSE for details.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
internal
|
|
|
config
Package config handles configuration and command line argument parsing for ghprmerge.
|
Package config handles configuration and command line argument parsing for ghprmerge. |
|
github
Package github provides interfaces and implementations for interacting with GitHub API.
|
Package github provides interfaces and implementations for interacting with GitHub API. |
|
merger
Package merger implements the core logic for discovering, evaluating, and merging pull requests.
|
Package merger implements the core logic for discovering, evaluating, and merging pull requests. |
|
output
Package output handles formatting and displaying results.
|
Package output handles formatting and displaying results. |
Click to show internal directories.
Click to hide internal directories.