-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add basic doc on making dep changes based on previously written one
- Loading branch information
Showing
2 changed files
with
21 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
Making dependency changes | ||
========================= | ||
|
||
Updating Python package dependencies | ||
------------------------------------ | ||
|
||
To update all dependencies, the GitHub Actions workflow for generating requirements files should be used: | ||
https://github.com/Cog-Creators/Red-DiscordBot/actions/workflows/run_pip_compile.yaml | ||
|
||
Run the above workflow and, after it finishes, download the "merged" artifact archive. | ||
Copy all of the files from this archive to the ``requirements/`` directory in the repository, | ||
overriding any already present files. Now, you can look at the git diff to see | ||
which dependency versions changed. | ||
|
||
When updating a dependency to a newer version: | ||
|
||
- Verify that all code commented with ``DEP-WARN`` is not affected by the new dependency versions | ||
- Read the changelogs for dependencies to make sure there are no (breaking) changes | ||
that may affect our code |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -9,3 +9,5 @@ Full Table of Contents | |
|
||
.. toctree:: | ||
:maxdepth: 2 | ||
|
||
dependency-changes |