Skip to content

Commit bac6da8

Browse files
authored
docs: update description of delete-branch
1 parent a4f52f8 commit bac6da8

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,11 @@ In addition to a message, the `commit-message` input can also be used to populat
9191
#### delete-branch
9292

9393
The `delete-branch` feature doesn't delete branches immediately on merge. (It can't do that because it would require the merge to somehow trigger the action.)
94-
The intention of the feature is that when the action next runs it will delete the `branch` if it doesn't have an active pull request associated with it.
94+
The intention of the feature is that when the action next runs it will delete the `branch` if there is no diff.
95+
96+
Enabling this feature leads to the following behaviour:
97+
1. If a pull request was merged and the branch is left undeleted, when the action next runs it will delete the branch if there is no further diff.
98+
2. If a pull request is open, but there is now no longer a diff and the PR is unnecessary, the action will delete the branch causing the PR to close.
9599

96100
If you want branches to be deleted immediately on merge then you should use GitHub's `Automatically delete head branches` feature in your repository settings.
97101

0 commit comments

Comments
 (0)