zydronium/manage.get.gov
1
0
Fork 0
mirror of https://github.com/cisagov/manage.get.gov.git synced 2025-08-05 17:28:31 +02:00
Code Issues Projects Releases Packages Wiki Activity

Update and organize documentation

Browse source
This commit is contained in:
Seamus Johnston 2022-08-31 15:39:44 -05:00
parent d88fa8fb3e
commit 2386258159
No known key found for this signature in database
GPG key ID: 2F21225985069105
8 changed files with 98 additions and 64 deletions
Download patch file Download diff file Expand all files Collapse all files

8
docs/operations/runbooks/update_python_dependencies.md Normal file
View file

@ -0,0 +1,8 @@
# HOWTO Update Python Dependencies
========================
1. Check the [Pipfile](./src/Pipfile) for pinned dependencies and manually adjust the version numbers
1. Run `cd src`, `docker-compose up -d`, and `docker-compose exec app pipenv update` to perform the upgrade and generate a new [Pipfile.lock](./src/Pipfile.lock)
1. (optional) Run `docker-compose stop` and `docker-compose build` to build a new image for local development with the updated dependencies.
The reason for de-coupling the `build` and `update` steps is to increase consistency between builds and reduce "it works on my laptop!". Therefore, `build` uses the lock file as-is; dependencies are never updated except by explicit choice.