Skip to content
This repository has been archived by the owner on May 4, 2022. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jrday authored Mar 4, 2020
1 parent ba1f2e1 commit 9db21cc
Showing 1 changed file with 30 additions and 7 deletions.
37 changes: 30 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,43 @@

<!---atomist-skill-readme:start--->

Atomist Skill to automatically delete pull request branches when the PR gets closed.
Once a pull request is merged or closed, the head branch will be deleted. This skill is configured to work on any number of repositories without needing to edit individual repository settings on GitHub.com.

### **Enabling branch auto-deletion**

To enable auto-deletion, one of the auto-delete policy labels must be added to the pull request. Set the default auto-deletion policy in order for this skill to automatically apply the labels to new pull requests raised.

- `auto-branch-delete:on-merge`
- `auto-branch-delete:on-close`

The labels are automatically added to the repository when this skill is enabled.

## Configuration

### Enable Branch Deletion
### Default auto-deletion policy

To set the default policy to use when auto-deleting branches when no explicit label is applied to the pull request,
select one of the options.

- **On pull request merge** — Deletes head branch when a pull request is merged.
- **On pull request close or merge** — Deletes head branch when a pull request is closed regardless of its merge status.

### Which repositories

By default, this skill will be enabled for all repositories in all organizations you have connected.
To restrict the organizations or specific repositories on which the skill will run, you can explicitly
choose organization(s) and repositories.

## Integrations

To enable auto-merging, one the following labels has to be assigned to the pull request:
**GitHub**

* `auto-branch-delete:on-close` deletes head branch when the PR gets closed regardless of its merge status
* `auto-branch-delete:on-merge` deletes head branch when the PR gets merged
The Atomist GitHub integration must be configured to used this skill. At least one repository must be selected.

### Label Management
**Slack**

The labels are automatically added to the repository when this skill gets enabled and PRs are created.
If the Atomist Slack integration is configured, this skill will send a notification message to the configured
Slack channel when a branch is deleted.

<!---atomist-skill-readme:end--->

Expand Down

0 comments on commit 9db21cc

Please sign in to comment.