|
| 1 | +# Initial Release |
| 2 | + |
| 3 | +This is the initial release of git-multibranch-resource, a resource for |
| 4 | +testing multiple branches of a git repository in a single pipeline. |
| 5 | + |
| 6 | +## Functionality |
| 7 | + |
| 8 | +By using `branches` instead of `branch` in the source configuration, you specify a |
| 9 | +regular expression patter of the branches you want to target. Optionally, if |
| 10 | +you specify `ignore_branches`, you can set a similar pattern for branches that |
| 11 | +you want to ommit (takes precidence over `branches`) |
| 12 | + |
| 13 | +## Everythings better with redis |
| 14 | + |
| 15 | +If you use the optional redis extension, you will reap the following benefits: |
| 16 | +* The ref space will not be cluttered with all the latests refs for all other |
| 17 | + branches. |
| 18 | + * Normally the first ref listed is the ref for that ci run, will all the |
| 19 | + other refs used to track what branch refs have already been tested. With |
| 20 | + redis available, this extra information is stored in redis. |
| 21 | +* No branch update will be untested. |
| 22 | + * If you have enough workers, this isn't usually a problem. But if it is, |
| 23 | + the check will be prevented from reporting another branch's latest ref |
| 24 | + until a worker is available. This prevents branches from being skipped by |
| 25 | + a later reported ref of another branch. |
| 26 | + |
| 27 | +## ToDo |
| 28 | + |
| 29 | +Features of future releases includes: |
| 30 | +* The wait until worker available feature should continue checking if there's |
| 31 | + an update for the pending branch and report updates for that branch, but no |
| 32 | + others. |
| 33 | + |
0 commit comments