Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document how dependency changes should be made #2

Merged
merged 4 commits into from
Feb 3, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions source/dependency-changes.rst
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
1 change: 1 addition & 0 deletions source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@ Full Table of Contents
:maxdepth: 3

core-devs/index
dependency-changes
Loading