mirror of
https://github.com/ansible/awx.git
synced 2026-01-11 10:00:01 -03:30
f3fd9945d6
* prometheus-client returns an additional value as of v.0.22.0 * add license, remove outdated ones, add new embedded sources * update requirements and UPGRADE BLOCKERs in README
67 lines
2.5 KiB
Markdown
67 lines
2.5 KiB
Markdown
# Dependency Management
|
|
|
|
The `requirements.txt` file is generated from `requirements.in` and `requirements_git.txt`, using `pip-tools` and `pip-compile`.
|
|
|
|
## How To Use
|
|
|
|
Commands should be run in the awx container from inside the `./requirements` directory of the awx repository.
|
|
|
|
### Upgrading or Adding Select Libraries
|
|
|
|
If you need to add or upgrade one targeted library, then modify `requirements.in`,
|
|
then run the script:
|
|
|
|
`./updater.sh run`
|
|
|
|
#### Upgrading Unpinned Dependency
|
|
|
|
If you require a new version of a dependency that does not have a pinned version
|
|
for a fix or feature, pin a minimum version in `requirements.in` and run `./updater.sh run`. For example,
|
|
replace the line `asgi-amqp` with `asgi-amqp>=1.1.4`, and consider leaving a
|
|
note.
|
|
|
|
Then next time that a general upgrade is performed, the minimum version specifiers
|
|
can be removed, because `*.txt` files are upgraded to latest.
|
|
|
|
### Upgrading Dependencies
|
|
|
|
You can upgrade (`pip-compile --upgrade`) the dependencies by running
|
|
|
|
`./updater.sh upgrade`.
|
|
|
|
## Licenses and Source Files
|
|
|
|
If any library has a change to its license with the upgrade, then the license for that library
|
|
inside of `licenses` needs to be updated.
|
|
|
|
For libraries that have source distribution requirements (LGPL as an example),
|
|
a tarball of the library is kept along with the license.
|
|
To download the PyPI tarball, you can run this command:
|
|
|
|
```
|
|
pip download <pypi library name> -d licenses/ --no-binary :all: --no-deps
|
|
```
|
|
|
|
Make sure to delete the old tarball if it is an upgrade.
|
|
|
|
## UPGRADE BLOCKERs
|
|
|
|
Anything pinned in `*.in` files involves additional manual work in
|
|
order to upgrade. Some information related to that work is outlined here.
|
|
|
|
### pip, setuptools and setuptools_scm, wheel, cython
|
|
|
|
If modifying these libraries make sure testing with the offline build is performed to confirm
|
|
they are functionally working. Versions need to match the versions used in the pip bootstrapping
|
|
step in the top-level Makefile.
|
|
|
|
Verify ansible-runner's build dependency doesn't conflict with the changes made.
|
|
|
|
### urllib3 and OPA-python-client
|
|
There are incompatible version dependancies for urllib3 between OPA-python-client and kubernetes.
|
|
OPA-python-client v2.0.3+ requires urllib3 v2.5.0+ and kubernetes v34.1.0 caps it at v.2.4.0.
|
|
|
|
## djangorestframework
|
|
Upgrading to 3.16.1 introduced errors on the tests around CredentialInputSource. We have several
|
|
fields on that model set to default=null but in the serializer they're set to required: true which causes
|
|
a conflict. |