Make lockfiles optional for dev containers. #620
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rochacbruno
requested review from
alikins,
awcrosby,
chouseknecht,
cutwater and
newswangerd
as code owners
Add `LOCK_REQUIREMENTS` variable on `.compose.env` when this variable is set to `0` compose build will bypass the installation of `requirements/*` lock files avoiding VersionConflicts when using `master` checkout for `pulpcore` and `pulp_ansible`. also if that variable is set to `0` the entrypoint invoked by `./compose up|run` will bypass the optization argument `--no-deps` allowing the installation of bleeding edge requirements introduced by pulp_ansible/pulpcore. 1. Clone locally `galaxy_ng`, `pulpcore` and `pulp_ansible` all the repos must be located at the same directory level. ``` cd ~/projects/ git clone https://github.com/pulp/pulpcore git clone https://github.com/pulp/pulp_ansible git clone https://github.com/ansible/galaxy_ng git clone https://github.com/ansible/ansible-hub-ui git clone https://github.com/ansible/galaxy_importer ``` 2. `pulp_ansible` master is compatible with a specific range of `pulpcore` versions. So the recommended is to checkout to specific branch or tag following the contraints defined on pulp_ansible/requirements.txt or leave it checked out to master if you know it is compatible with the pulp_ansible branch you have. Example: ``` cd ~/projects/pulpcore git checkout 3.9.0 ``` This is also possible to checkout to specific pull-requests by its `refs/pull/id`. 3. Edit the `galaxy_ng/.compose.env` file. ``` cd ~/projects/galaxy_ng cat .compose.env COMPOSE_PROFILE=standalone DEV_SOURCE_PATH='pulpcore:pulp_ansible:galaxy_ng' LOCK_REQUIREMENTS=0 ``` **DEV_SOURCE_PATH** refers to the repositories you cloned locally, the order is important from the highest to the low dependecy, otherwise pip will raise version conflicts. **LOCK_REQUIREMENTS** when set to 0 it tells docker to bypass the install of pinned requirements and rely only on packages defined on `setup.py` for each repo. 4. Run `./compose build` to make those changes efective. 5. Run desired compose command: `./compose up`, `./compose run` etc... Further details on How to run galaxy_ng dev environment with specific git branched are written on the galaxy_ng/wiki. Issue: AAH-257
|
|
newswangerd
approved these changes
Feb 2, 2021
There was a problem hiding this comment.
LGTM. Can you add the notes in the PR here to our wiki?
https://github.com/ansible/galaxy_ng/wiki/Development-Setup
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes
Add
LOCK_REQUIREMENTSvariable on.compose.envwhen this variable is set to
0compose build willbypass the installation of
requirements/*lock filesavoiding VersionConflicts when using
mastercheckoutfor
pulpcoreandpulp_ansible.also if that variable is set to
0the entrypoint invokedby
./compose up|runwill bypass the optization argument--no-depsallowing the installation of bleeding edgerequirements introduced by pulp_ansible/pulpcore.
NO breaking change is added, the new variable is by default set to
1to keep the current behaviour.Steps to run dev environment with specific upstream branch
Clone locally
galaxy_ng,pulpcoreandpulp_ansibleall therepos must be located at the same directory level.
Checkout to desired branches.
pulp_ansiblemaster is compatible with a specific range ofpulpcoreversions. So the recommended is to checkout to specific branch or
tag following the contraints defined on pulp_ansible/requirements.txt
or leave it checked out to master if you know it is compatible with
the pulp_ansible branch you have.
Example:
This is also possible to checkout to specific pull-requests by its
refs/pull/id.Edit the
galaxy_ng/.compose.envfile.DEV_SOURCE_PATH refers to the repositories you cloned
locally, the order is important from the highest to the low
dependecy, otherwise pip will raise version conflicts.
So pulpcore is a dependency to pulp_ansible which is a dependency to galaxy_ng, this order must be respected on DEV_SOURCE_PATH variable.
LOCK_REQUIREMENTS when set to 0 it tells docker to
bypass the install of pinned requirements and rely
only on packages defined on
setup.pyfor each repo.Run
./compose buildto make those changes efective.Run desired compose command:
./compose up,./compose runetc...Further details on How to run galaxy_ng dev environment
with specific git branched are written on the galaxy_ng/wiki.
Issue: AAH-257