|
| 1 | +--- |
| 2 | +name: bundle-dependency-prs |
| 3 | +description: Fix broken dependency update PRs and aggregate the ones that work into one PR. |
| 4 | +disable-model-invocation: true |
| 5 | +--- |
| 6 | + |
| 7 | +# Instructions |
| 8 | + |
| 9 | +You have two goals: |
| 10 | + |
| 11 | +1. Get all dependency PRs to a state where their PR checks pass. |
| 12 | +2. Aggregate dependency PRs with passing checks into just one PR. |
| 13 | + |
| 14 | +You can identify dependency update PRs by those authored by `dependabot` or `renovate`. |
| 15 | + |
| 16 | +You'll find instructions for building and validating the repo in the [CONTRIBUTING.md](../../../CONTRIBUTING.md) doc. |
| 17 | +Always validate your changes locally before pushing them to the remote repository. |
| 18 | + |
| 19 | +When writing PR bodies or comments, avoid unmatched markdown code fences. Keep markdown well-formed. |
| 20 | + |
| 21 | +For purposes of assessing PR readiness by its PR checks, consider docfx related checks to be irrelevant. |
| 22 | +If a docfx check fails but all other checks succeed, then that is a 'successful' dependency update PR. |
| 23 | + |
| 24 | +## Fix up dependency PRs with failing checks |
| 25 | + |
| 26 | +Before aggregating PRs, first try to fix any individual dependency update PRs with failing build/test checks. |
| 27 | + |
| 28 | +1. For the dependency PRs with failing build or test PR checks, check out their source branch and fix any issues. |
| 29 | +2. Push your fixes as fresh commits to the individual dependency PRs. |
| 30 | +3. If you can't fix a particular PR, add a comment to the PR describing your attempt and outcome. |
| 31 | + |
| 32 | +## Group dependency PRs that are ready to go |
| 33 | + |
| 34 | +Your next goal is to collect all the dependency updates that are ready to go into a single PR. |
| 35 | + |
| 36 | +1. Prepare a local branch called `bulkDepUpdates`. |
| 37 | + 1. Consider that a remote branch by the same name may already exist. If it does, base your local branch on it. |
| 38 | + 2. Merge `origin/main` into this branch. |
| 39 | + 3. Resolve any conflicts. |
| 40 | +2. For the dependency PRs whose build and test PR checks already pass, merge them into the `bulkDepUpdates` branch. |
| 41 | + Consider that your local branch may have already merged an equivalent PR in the past (from a past run). If so, you should skip merging that PR. |
| 42 | + Resolve any conflicts. |
| 43 | + Build and run tests to validate your branch. |
| 44 | +3. Push the branch. |
| 45 | +4. Create a PR, if one does not already exist. |
0 commit comments