File tree Expand file tree Collapse file tree 2 files changed +20
-0
lines changed Expand file tree Collapse file tree 2 files changed +20
-0
lines changed Original file line number Diff line number Diff line change 1+ Making dependency changes
2+ =========================
3+
4+ Updating Python package dependencies
5+ ------------------------------------
6+
7+ To update all dependencies, the GitHub Actions workflow for generating requirements files should be used:
8+ https://github.com/Cog-Creators/Red-DiscordBot/actions/workflows/run_pip_compile.yaml
9+
10+ Run the above workflow and, after it finishes, download the "merged" artifact archive.
11+ Copy all of the files from this archive to the ``requirements/ `` directory in the repository,
12+ overriding any already present files. Now, you can look at the git diff to see
13+ which dependency versions changed.
14+
15+ When updating a dependency to a newer version:
16+
17+ - Verify that all code commented with ``DEP-WARN `` is not affected by the new dependency versions
18+ - Read the changelogs for dependencies to make sure there are no (breaking) changes
19+ that may affect our code
Original file line number Diff line number Diff line change @@ -11,3 +11,4 @@ Full Table of Contents
1111 :maxdepth: 3
1212
1313 core-devs/index
14+ dependency-changes
You can’t perform that action at this time.
0 commit comments