Skip to content

Commit 797cbfb

Browse files
committed
add clarity on the why.
1 parent e50cddc commit 797cbfb

1 file changed

Lines changed: 4 additions & 1 deletion

File tree

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,12 @@ This is a GitHub Action to automatically rebuild pull requests when the pull req
33

44
Review the GitHub action in the marketplace: [GitHub Rebuild PullRequests](https://github.com/marketplace/actions/github-rebuild-pull-requests)
55

6-
### How does this GitHub action work?
6+
## How does this GitHub action work?
77
When a branch in your GitHub repository is updated, this GitHub action automatically finds open pull requests that target that branch and forces a rebuild for them.
88

9+
## Why?
10+
This GitHub action exists because GitHub will not re-trigger builds. That means when a PR targets a branch and that branch changes, that PR is now out of date. That meas tests are not rerun, validations are not rechecked. Breaking changes will be present and not validated. By adding in this action, those PR will be automatically rerun.
11+
912
## Usage
1013
In your GitHub action workflow add the follow step.
1114

0 commit comments

Comments
 (0)