Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jessfraz/branch-cleanup-action
A GitHub action to automatically delete the branch after a pull request has been merged.
https://github.com/jessfraz/branch-cleanup-action
Last synced: about 1 month ago
JSON representation
A GitHub action to automatically delete the branch after a pull request has been merged.
- Host: GitHub
- URL: https://github.com/jessfraz/branch-cleanup-action
- Owner: jessfraz
- License: mit
- Created: 2018-11-20T18:26:09.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-03-02T13:52:50.000Z (over 2 years ago)
- Last Synced: 2024-02-04T19:59:09.556Z (5 months ago)
- Language: Shell
- Size: 659 KB
- Stars: 426
- Watchers: 10
- Forks: 60
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Lists
- awesome-list - branch-cleanup-action
- awesome-stars - jessfraz/branch-cleanup-action - A GitHub action to automatically delete the branch after a pull request has been merged. (Shell)
- awesome - jessfraz/branch-cleanup-action - A GitHub action to automatically delete the branch after a pull request has been merged. (Shell)
- awesome - Cleanup branches after merge
- awesome-stars - branch-cleanup-action
- awesome-actions - Cleanup branches after merge
- awesome-actions - Cleanup branches after merge
README
# Branch Cleanup Action
[](https://travis-ci.org/jessfraz/branch-cleanup-action)
A GitHub action to automatically delete the branch after a pull request has been merged. Here's [a blog post](https://blog.jessfraz.com/post/the-life-of-a-github-action/) 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](#usage)
- [Contributing](#contributing)
* [Running the tests](#running-the-tests)
## Usage
```
workflow "on pull request merge, delete the branch" {
on = "pull_request"
resolves = ["branch cleanup"]
}
action "branch cleanup" {
uses = "jessfraz/branch-cleanup-action@master"
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/branch-cleanup-action@master"
secrets = ["GITHUB_TOKEN"]
env = {
NO_BRANCH_DELETED_EXIT_CODE = "0"
}
}
```
## Contributing
### Running the tests
The tests use [shellcheck](https://github.com/koalaman/shellcheck). You don't need to install anything (assuming you have [docker](https://www.docker.com) installed). The tests run in a container.
```console
$ make test
```