diff options
| author | Jake Jackson <jljacks93@gmail.com> | 2024-08-20 20:21:27 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-08-20 20:21:27 +0200 |
| commit | 39d1922b805af4621de980fbb43e6ebea42b7dd2 (patch) | |
| tree | 9ed37d6d0c96be44c9cb98ff179030e6797b07df /tools | |
| parent | Unpin django-guid and update license (#15381) (diff) | |
| download | awx-39d1922b805af4621de980fbb43e6ebea42b7dd2.tar.xz awx-39d1922b805af4621de980fbb43e6ebea42b7dd2.zip | |
Update editable deps docs (#15451)
update editable deps docs
Diffstat (limited to 'tools')
| -rw-r--r-- | tools/docker-compose/editable_dependencies/README.md | 13 |
1 files changed, 6 insertions, 7 deletions
diff --git a/tools/docker-compose/editable_dependencies/README.md b/tools/docker-compose/editable_dependencies/README.md index aa67cebb50..fa9f5c39e4 100644 --- a/tools/docker-compose/editable_dependencies/README.md +++ b/tools/docker-compose/editable_dependencies/README.md @@ -2,13 +2,13 @@ This folder contains the symlink to editable dependencies for AWX -During the bootstrap of awx development environment we will try to crawl through the symlinks and mount (the source of the symlink) to `tools_awx_` containers and `init_awx` containers than install all the dependencies in editable mode +During the bootstrap of awx development environment we will try to crawl through the symlinks and mount (the source of the symlink) to `tools_awx_` containers and `init_awx` containers then install all the dependencies in editable mode ## How to enable/disable editable dependnecies ### Enable -Set `EDITABLE_DEPENDENCIES=true` either as an Environment Variable with before invoking `make docker-compose` +Set `EDITABLE_DEPENDENCIES=true` either as an Environment Variable before invoking `make docker-compose` ```bash export EDITABLE_DEPENDENCIES=true @@ -21,7 +21,7 @@ or during invocation of `make docker-compose` EDITABLE_DEPENDENCIES=true make docker-compose ``` -will cause the `make docker-compose-source` to template out docker-compose file with editable dependencies. +This will cause the `make docker-compose-source` to template out docker-compose file with editable dependencies. ### Disable @@ -31,12 +31,12 @@ To disable editable dependency simply `unset EDITABLE_DEPENDENCIES` Adding symlink to the directory that contains the source of the editable dependencies will cause the dependency to be mounted and installed in the docker-compose development environment. -Both relative path or absolute path will work +Both relative path or absolute path will work. ### Examples I have `awx` checked out at `~/projects/src/github.com/TheRealHaoLiu/awx` -I have `django-ansible-base` checked out at `~/projects/src/github.com/TheRealHaoLiu/ansible-runner` +I have `django-ansible-base` checked out at `~/projects/src/github.com/TheRealHaoLiu/django-ansible-base` From root of AWX project `~/projects/src/github.com/TheRealHaoLiu/awx` @@ -56,11 +56,10 @@ ln -s ../ansible-runner tools/docker-compose/editable_dependencies/ Simply removing the symlink from `tools/docker-compose/editable_dependencies` **will cause problem**! -and the volume `tools_awx_var_lib` need to be deleted with +and the volume `tools_awx_var_lib` needs to be deleted as well with ```bash make docker-compose-down docker volume rm tools_awx_var_lib ``` -TODO(TheRealHaoLiu): bear proof this? maybe just always delete tools_awx_var_lib? |