https://github.com/davideviolante/pr-automerge-action

GitHub Action to automatically merge pull requests when approved by N reviewers.
https://github.com/davideviolante/pr-automerge-action

Last synced: 13 days ago
JSON representation

GitHub Action to automatically merge pull requests when approved by N reviewers.

• Host: GitHub
• URL: https://github.com/davideviolante/pr-automerge-action
• Owner: DavideViolante
• License: mit
• Created: 2020-05-14T12:23:25.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-10-01T07:16:00.000Z (about 1 month ago)
• Last Synced: 2024-10-12T17:09:22.275Z (27 days ago)
• Language: JavaScript
• Homepage:
• Size: 670 KB
• Stars: 4
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Pull Request auto merge action

[![](https://github.com/davideviolante/pr-automerge-action/workflows/Node.js%20CI/badge.svg)](https://github.com/DavideViolante/pr-automerge-action/actions?query=workflow%3A%22Node.js+CI%22) [![Coverage Status](https://coveralls.io/repos/github/DavideViolante/pr-automerge-action/badge.svg?branch=master)](https://coveralls.io/github/DavideViolante/pr-automerge-action?branch=master) [![Maintainability](https://api.codeclimate.com/v1/badges/60f9b3a6b4177a0bfe77/maintainability)](https://codeclimate.com/github/DavideViolante/pr-automerge-action/maintainability) [![Donate](https://img.shields.io/badge/paypal-donate-179BD7.svg)](https://www.paypal.me/dviolante)

GitHub Action to automatically merge pull requests when some conditions are met.

## Inputs

### merge-method

Pull request merge method: "merge", "squash", "rebase". Default is "squash".

### min-approvals

Minimum number of approvals needed on a pull request to be merged. Default is 2.

### base-ref

Base ref branch to filter pull requests. Default is "dev".

## Example usage

```yaml

name: PRs auto merge

on:

  schedule:

    # Every friday every hour between 12 and 15 UTC

    - cron: "0 12-15 * * 5"

jobs:

  pr-automerge:

    runs-on: ubuntu-latest

    steps:

    - uses: davideviolante/[email protected]

      env:

        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

      with:

        merge-method: 'squash' # Default 'squash'

        min-approvals: 2 # Default 2

        base-ref: 'dev' # Default 'dev'

```

## Bug or feedback?

Please open an issue.

## Author

- [Davide Violante](https://github.com/DavideViolante)