Skip to content

Commit dcebaa5

Browse files
committed
Add detail in ADR
1 parent f48e20f commit dcebaa5

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

docs/design/0006-use-merge-queue-in-ci.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,15 @@ merging`. It ensures that pull requests have been tested with the latest code.
1414
Even if it is a good practice, it begins to have an impact on maintainers velocity. It
1515
implies updating each pull request after any modification to the `main` branch.
1616

17+
For example, suppose that there are several PRs that are done and ready to merge. With
18+
the current system, it is not possible to simply go through the PRs and merge them; one
19+
needs to, for each PR:
20+
- Put a lock on the PR merges (`main` should not move until the PR is merged),
21+
- Update the PR with `main`,
22+
- Wait for CI to pass (~10 min today),
23+
- Merge,
24+
- Release the lock.
25+
1726
## Decision Outcome
1827

1928
We decide to add a merge queue to the `main` branch.
@@ -37,8 +46,8 @@ https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-
3746
3847
### Consequences
3948

40-
We have to made some changes to prepare the setup of the GH merge queue, for which we
41-
need to specify the jobs required to succeed (and not global workflows unfortunately).
49+
We have to make some changes to prepare the setup of the GH merge queue, for which we
50+
need to specify the jobs required to succeed (as opposed to specifying global workflow).
4251

4352
For a job to be required, its workflow must be executed and not skipped. Currently, we
4453
skip entire workflow via path filtering to avoid unnecessary calculations, which is

0 commit comments

Comments
 (0)