added documentation and fixed piplock file

This commit is contained in:
Alysia Broddrick 2023-12-13 22:14:22 -08:00
parent 6b3e5a39e3
commit 6390795254
No known key found for this signature in database
GPG key ID: 03917052CD0F06B7
2 changed files with 5 additions and 3 deletions

View file

@ -13,7 +13,9 @@
It is necessary to use `bash -c` because `run pipenv requirements` will not recognize that it is running non-interactively and will include garbage formatting characters.
The requirements.txt is used by Cloud.gov. It is needed to work around a bug in the CloudFoundry buildpack version of Pipenv that breaks on installing from a git repository.
3. (optional) Run `docker-compose stop` and `docker-compose build` to build a new image for local development with the updated dependencies.
3. Change geventconnpool back to what it was originally within the Pipfile.lock and requirements.txt.
This is done by either saving what it was originally or opening a PR and using that as a reference to undo changes to any mention of geventconnpool.
Geventconnpool, when set as a requirement without the reference portion, is defaulting to get a commit from 2014 which then breaks the code, as we want the newest version from them.
4. (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 `lock` steps is to increase consistency between builds--a run of `build` will always get exactly the dependencies listed in `Pipfile.lock`, nothing more, nothing less.

2
src/Pipfile.lock generated
View file

@ -448,7 +448,7 @@
},
"geventconnpool": {
"git": "https://github.com/rasky/geventconnpool.git",
"ref": null
"ref": "1bbb93a714a331a069adf27265fe582d9ba7ecd4"
},
"greenlet": {
"hashes": [