Skip to content

Commit aa273b5

Browse files
kiviewrnorth
andauthored
Document Dependabot merge process (#4556)
Co-authored-by: Richard North <[email protected]>
1 parent d21a3df commit aa273b5

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

docs/contributing.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,3 +90,17 @@ New modules should have the following warning at the top of their documentation
9090
This module is INCUBATING. While it is ready for use and operational in the current version of Testcontainers, it is possible that it may receive breaking changes in the future. See [our contributing guidelines](/contributing/#incubating-modules) for more information on our incubating modules policy.
9191

9292
We will evaluate incubating modules periodically, and remove the label when appropriate.
93+
94+
95+
## Combining Dependabot PRs
96+
97+
Since we generally get a lot of Dependabot PRs, we regularly combine them into single commits.
98+
For this, we are using the [gh-combine-prs](https://github.com/rnorth/gh-combine-prs) extension for [GitHub CLI](https://cli.github.com/).
99+
100+
The whole process is as follow:
101+
102+
1. Check that all open Dependabot PRs did succeed their build. If they did not succeed, trigger a rerun if the cause were external factors or else document the reason if obvious.
103+
2. Run the extension from an up-to-date local `master` branch: `gh combine-prs --query "author:app/dependabot"`
104+
3. Merge conflicts might appear. Just ignore them, we will get those PRs in a future run.
105+
4. Once the build of the combined PR did succeed, temporarily enable merge commits and merge the PR using a merge commit through the GitHub UI.
106+
5. After the merge, disable merge commits again.

0 commit comments

Comments
 (0)