Skip to content

Commit

Permalink
Add basic doc on making dep changes based on previously written one
Browse files Browse the repository at this point in the history
  • Loading branch information
Jackenmen committed Sep 15, 2024
1 parent 1940634 commit cdc18e1
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 0 deletions.
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
2 changes: 2 additions & 0 deletions source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,5 @@ Full Table of Contents

.. toctree::
:maxdepth: 2

dependency-changes

0 comments on commit cdc18e1

Please sign in to comment.