External-Mirrors/awx
2
0
Fork 0
mirror of https://github.com/ansible/awx.git synced 2026-03-07 19:51:08 -03:30
Code Issues Packages Projects Releases Wiki Activity

Updating README and update.sh usage

Browse Source
This commit is contained in:
John Westcott IV
2022-11-09 10:15:36 -05:00
parent d6004fd2d3
commit fe1b37afaf
2 changed files with 42 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
requirements/README.md
View File

@@ -1,25 +1,22 @@
# Dependency Management # Dependency Management
The `requirements.txt` file is generated from `requirements.in`, using `pip-tools` `pip-compile`. The `requirements.txt` file is generated from `requirements.in` and `requirements_git.txt`, using `pip-tools` and `pip-compile`.
## How To Use ## How To Use
Commands should be run from inside the `./requirements` directory of the awx repository. Commands should be run in the awx container from inside the `./requirements` directory of the awx repository.
### Upgrading or Adding Select Libraries ### Upgrading or Adding Select Libraries
If you need to add or upgrade one targeted library, then modify `requirements.in`, If you need to add or upgrade one targeted library, then modify `requirements.in`,
then run the script: then run the script:
`./updater.sh` `./updater.sh run`
NOTE: `./updater.sh` uses /usr/bin/python3.6, to match the current python version
(3.6) used to build releases.
#### Upgrading Unpinned Dependency #### Upgrading Unpinned Dependency
If you require a new version of a dependency that does not have a pinned version 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 and run `./updater.sh`. For example, 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 replace the line `asgi-amqp` with `asgi-amqp>=1.1.4`, and consider leaving a
note. note.

40
requirements/updater.sh
View File

@@ -33,11 +33,47 @@ generate_requirements() {
main() { main() {
base_dir=$(pwd) base_dir=$(pwd)
_tmp="$(mktemp -d --suffix .awx-requirements XXXX -p /tmp)"
_tmp=$(python -c "import tempfile; print(tempfile.mkdtemp(suffix='.awx-requirements', dir='/tmp'))")
trap _cleanup INT TERM EXIT trap _cleanup INT TERM EXIT
if [ "$1" = "upgrade" ]; then case $1 in
"run")
NEEDS_HELP=0
;;
"upgrade")
NEEDS_HELP=0
pip_compile="${pip_compile} --upgrade" pip_compile="${pip_compile} --upgrade"
;;
"help")
NEEDS_HELP=1
;;
*)
echo ""
echo "ERROR: Parameter $1 not valid"
echo ""
NEEDS_HELP=1
;;
esac
if [[ "$NEEDS_HELP" == "1" ]] ; then
echo "This script generates requirements.txt from requirements.in and requirements_git.in"
echo "It should be run from within the awx container"
echo ""
echo "Usage: $0 [run|upgrade]"
echo ""
echo "Commands:"
echo "help Print this message"
echo "run Run the process only upgrading pinned libraries from requirements.in"
echo "upgrade Upgrade all libraries to latest while respecting pinnings"
echo ""
exit
fi
if [[ ! -d /awx_devel ]] ; then
echo "This script should be run inside the awx container"
exit
fi fi
cp -vf requirements.txt "${_tmp}" cp -vf requirements.txt "${_tmp}"