This repository was archived by the owner on Apr 26, 2024. It is now read-only.
File tree Expand file tree Collapse file tree 2 files changed +15
-0
lines changed Expand file tree Collapse file tree 2 files changed +15
-0
lines changed Original file line number Diff line number Diff line change 1+ Document how to handle Dependabot pull requests.
Original file line number Diff line number Diff line change @@ -258,6 +258,20 @@ because [`build`](https://github.com/pypa/build) is a standardish tool which
258258doesn'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
You can’t perform that action at this time.
0 commit comments