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

Update editable deps docs (#15451)

Browse Source 
update editable deps docs
This commit is contained in:
Jake Jackson
2024-08-20 14:21:27 -04:00
committed by GitHub
parent 6b462cdfdb
commit 39d1922b80
1 changed files with 6 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
tools/docker-compose/editable_dependencies/README.md
View File

@@ -2,13 +2,13 @@
This folder contains the symlink to editable dependencies for AWX 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 ## How to enable/disable editable dependnecies
### Enable ### 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 ```bash
export EDITABLE_DEPENDENCIES=true export EDITABLE_DEPENDENCIES=true
@@ -21,7 +21,7 @@ or during invocation of `make docker-compose`
EDITABLE_DEPENDENCIES=true 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 ### 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. 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 ### Examples
I have `awx` checked out at `~/projects/src/github.com/TheRealHaoLiu/awx` 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` 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**! 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 ```bash
make docker-compose-down make docker-compose-down
docker volume rm tools_awx_var_lib docker volume rm tools_awx_var_lib
``` ```
TODO(TheRealHaoLiu): bear proof this? maybe just always delete tools_awx_var_lib?