Permalink
3a2f7e8 Nov 16, 2018
2 contributors

Users who have contributed to this file

@SvanBoxel @localheinz
73 lines (49 sloc) 3.58 KB

Delete merged branch

Build Status Want to see more badges? Click here!

Want to run this app with GitHub Actions? Click here

A GitHub app built with Probot that automatically deletes a branch after it's merged. That's it, enjoy!

Running it locally

  1. First, follow these instructions for making your own GitHub app. Give your app the following permissions:

    • Repository contents: Read & Write.
    • Pull requests: Read
  2. Then, clone the repo:

git clone git@github.com:SvanBoxel/delete-merged-branch.git
  1. Copy .env.example to .env and set the right environment variables as here

  2. Now, install app dependencies and run it:

# Install dependencies
npm install

# Run the bot
npm start

How it works

This GitHub app listens to the pull_request.closed webhook. If a pull request is closed and the connected branch is merged, it will delete the branch.

Configuration

The optional app configuration YAML file should be saved as .github/delete-merged-branch-config.yml. At the moment it supports the following options:

  • exclude (array) - list of branches that should not be automatically deleted after a merge.

Example .github/delete-merged-branch-config.yml:

exclude: 
  - development
  - qa

Release process

CI (Travis) is in charge of releasing new versions of the GitHub Application to Now. On every new commit to master we run semantic-release to determine whether the major/minor/patch version should be incremented. If so, we update the version running in production.

Running in GitHub actions

This app is compatible with GitHub Actions. You need to create a workflow that is triggered on the pull_request event for this. Then, you use this repo for the action. (SvanBoxel/delete-merged-branch@master). Don't forget to check the GITHUB_TOKEN secret. That's it.

Delete merged branch action

Contributing

If you have suggestions for how this GitHub app could be improved, or want to report a bug, open an issue! We'd love all and any contributions.

For more, check out the Contributing Guide.

License

ISC © 2018 Sebass van Boxel hello@svboxel.com

Badges

Build Status codecov Uptime Robot ratio (30 days) Greenkeeper badge Project maintainability