https://github.com/AdamVig/gh-automerge

GitHub CLI extension for enabling auto-merge on a pull request
https://github.com/AdamVig/gh-automerge

gh-extension

Last synced: 24 days ago
JSON representation

GitHub CLI extension for enabling auto-merge on a pull request

• Host: GitHub
• URL: https://github.com/AdamVig/gh-automerge
• Owner: AdamVig
• License: mit
• Created: 2023-10-05T02:10:47.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-24T18:34:08.000Z (3 months ago)
• Last Synced: 2024-10-26T04:00:30.097Z (2 months ago)
• Topics: gh-extension
• Language: Shell
• Homepage:
• Size: 10.7 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# gh-automerge

A GitHub (`gh`) CLI extension for enabling auto-merge on a pull request.

- Uses the pull request title and number for the merge commit message subject:

	> Create auto-merge extension (#1234)

- Generates a body for the merge commit.

- If the branch contains more than one commit, asks if you want to use a specific commit or all commits (formatted as a markdown list) for the merge commit body.

- Prompts for confirmation of the merge commit message before proceeding.

- Displays the actual auto-merge commit message after enabling it.

- Adds a warning to the top of the pull request body for reviewers:

	> [!IMPORTANT]

	> **Auto-merge enabled**: approving this pull request will merge it.

## Installation

1. [Install the GitHub CLI](https://github.com/cli/cli#installation).

2. Install the extension.

   ```shell

   gh extension install AdamVig/gh-automerge

   ```

3. Ensure you have `fzf` installed.

## Usage

```shell

# In a GitHub repository

gh automerge

```