Skip to content
This repository was archived by the owner on Apr 26, 2024. It is now read-only.

Commit 8bc5d14

Browse files
authored
Document how to handle Dependabot pull requests. (#14916)
1 parent 836c592 commit 8bc5d14

File tree

2 files changed

+15
-0
lines changed

2 files changed

+15
-0
lines changed

changelog.d/14916.misc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Document how to handle Dependabot pull requests.

docs/development/dependencies.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -258,6 +258,20 @@ because [`build`](https://github.com/pypa/build) is a standardish tool which
258258
doesn't require poetry. (It's what we use in CI too). However, you could try
259259
`poetry build` too.
260260

261+
## ...handle a Dependabot pull request?
262+
263+
Synapse uses Dependabot to keep the `poetry.lock` file up-to-date. When it
264+
creates a pull request a GitHub Action will run to automatically create a changelog
265+
file. Ensure that:
266+
267+
* the lockfile changes look reasonable;
268+
* the upstream changelog file (linked in the description) doesn't include any
269+
breaking changes;
270+
* continuous integration passes (due to permissions, the GitHub Actions run on
271+
the changelog commit will fail, look at the initial commit of the pull request);
272+
273+
In particular, any updates to the type hints (usually packages which start with `types-`)
274+
should be safe to merge if linting passes.
261275

262276
# Troubleshooting
263277

0 commit comments

Comments
 (0)