GitHub Action
Merge me!
Automatically merge Pull Requests from the indicated github account.
Create a new .github/workflows/merge-me.yml
file:
name: Auto merge Dependabot updates
on:
check_suite:
types:
- completed
pull_request:
types:
- edited
- labeled
- opened
- ready_for_review
- reopened
- synchronize
- unlabeled
- unlocked
jobs:
merge-me:
name: Merge me!
runs-on: ubuntu-latest
steps:
- name: Merge me!
uses: ridedott/merge-me-action@master
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
Add a job as a last step of your CI workflow:
merge-me:
name: Merge me!
runs-on: ubuntu-latest
needs:
- all
- other
- required
- jobs
steps:
- name: Merge me!
uses: ridedott/merge-me-action@master
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
You may have another bot that also creates PRs against your repository and you
want to automatically merge those. By default, this GitHub Action assumes the
bot is dependabot
. You can override the bot name by
changing the value of GITHUB_LOGIN
parameter:
steps:
- name: Merge me!
uses: ridedott/merge-me-action@master
with:
GITHUB_LOGIN: my-awesome-bot-r2d2
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See usage notes on how to consume this package in your project.
Minimal requirements to set up the project:
- Node.js v12, installation instructions can be found on the official website, a recommended installation option is to use Node Version Manager. It can be installed in a few commands.
- A package manager npm. All instructions in the documentation will follow the npm syntax.
- Optionally a Git client.
Start by cloning the repository:
git clone git@github.com:ridedott/merge-me-action.git
In case you don't have a git client, you can get the latest version directly by using this link and extracting the downloaded archive.
Go the the right directory and install dependencies:
cd merge-me-action
npm install
That's it! You can now go to the next step.
This project uses Prettier to automate formatting. All supported files are being reformatted in a pre-commit hook. You can also use one of the two scripts to validate and optionally fix all of the files:
npm run format
npm run format:fix
This project uses ESLint to enable static analysis. TypeScript files are linted using a custom configuration. You can use one of the following scripts to validate and optionally fix all of the files:
npm run lint
npm run lint:fix
Publishing is handled in an automated way and must not be performed manually.
Each commit to the master branch is automatically tagged using
semantic-release
.
See CONTRIBUTING.md.
This project adheres to Semantic Versioning v2.