branch-cleanup-action

by jessfraz

A GitHub action to automatically delete the branch after a pull request has been merged.

428 Stars 58 Forks Last release: Not found MIT License 25 Commits 0 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

Branch Cleanup Action

Travis CI

A GitHub action to automatically delete the branch after a pull request has been merged. Here's a blog post describing this action in more detail.

NOTE: This will never delete the repository's default branch or protected branches. If the pull request is closed without merging, it will not delete it.

Table of Contents

Usage

workflow "on pull request merge, delete the branch" {
  on = "pull_request"
  resolves = ["branch cleanup"]
}

action "branch cleanup" { uses = "jessfraz/[email protected]" secrets = ["GITHUB_TOKEN"] }

If you include this in another Workflow, you may want to configure the environment variable

NO_BRANCH_DELETED_EXIT_CODE
. The default value for this is
78
, as Github Actions will mark a check as "neutral" (neither failed/succeeded) when you exit with code 78. This will however cancel any other actions running in parallel in this workflow.

If you don't want it to cancel, configure your workflow as follows:

action "branch cleanup" {
  uses = "jessfraz/[email protected]"
  secrets = ["GITHUB_TOKEN"]

env = { NO_BRANCH_DELETED_EXIT_CODE = "0" } }

demo

Contributing

Running the tests

The tests use shellcheck. You don't need to install anything (assuming you have docker installed). The tests run in a container.

$ make test

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.