1313
1414## Setup
1515
16- 1 . [ Git leaks detection] ( #git-leaks-detection )
17- 1 . [ Prepare a development environment] ( #prepare-a-development-environment )
18- 1 . [ Prepare a certification project] ( #prepare-a-certification-project )
19- 1 . [ Prepare an Operator bundle] ( #prepare-an-operator-bundle )
20- 1 . [ Prepare your ` ci.yaml ` ] ( #prepare-your-ciyaml )
21- 1 . [ Create a bundle pull request] ( #create-a-bundle-pull-request ) (optional)
22- - Required for testing hosted or release pipelines
23- 1 . [ Create an API key] ( #create-an-api-key ) (optional)
24- - Required for testing submission with the CI pipeline
25- 1 . [ Prepare the CI to run from your fork] ( ci-cd.md ) (optional)
26- - Required to run integration testing on forks of this repo.
16+ - [ Developer Guide] ( #developer-guide )
17+ - [ Workflow] ( #workflow )
18+ - [ Setup] ( #setup )
19+ - [ Git leaks detection] ( #git-leaks-detection )
20+ - [ Prepare a Development Environment] ( #prepare-a-development-environment )
21+ - [ Integration tests] ( #integration-tests )
22+ - [ Install tkn] ( #install-tkn )
23+ - [ Using CodeReady Containers] ( #using-codeready-containers )
24+ - [ Running a Pipeline with CRC] ( #running-a-pipeline-with-crc )
25+ - [ Prepare a Certification Project] ( #prepare-a-certification-project )
26+ - [ Prepare an Operator Bundle] ( #prepare-an-operator-bundle )
27+ - [ Prepare Your ci.yaml] ( #prepare-your-ciyaml )
28+ - [ Create a Bundle Pull Request] ( #create-a-bundle-pull-request )
29+ - [ Create an API Key] ( #create-an-api-key )
30+ - [ Making Changes to the Pipelines] ( #making-changes-to-the-pipelines )
31+ - [ Guiding Principles] ( #guiding-principles )
32+ - [ Applying Pipeline Changes] ( #applying-pipeline-changes )
33+ - [ Making Changes to the Pipeline Image] ( #making-changes-to-the-pipeline-image )
34+ - [ Dependency] ( #dependency )
35+ - [ Run Unit Tests, Code Style Checkers, etc.] ( #run-unit-tests-code-style-checkers-etc )
36+ - [ Preparation on RPM-based Linux] ( #preparation-on-rpm-based-linux )
37+ - [ Preparation on other Linux systems] ( #preparation-on-other-linux-systems )
38+ - [ Run the local tests] ( #run-the-local-tests )
39+ - [ Local development] ( #local-development )
40+ - [ Build \& Push] ( #build--push )
2741
2842### Git leaks detection
2943
@@ -280,30 +294,23 @@ oc apply -R -f ansible/roles/operator-pipeline/templates/openshift
280294# ## Dependency
281295
282296Operator pipelines project is configured to automatically manage Python
283- dependencies using [PDM ][1] tool. The pdm automates definition, installation,
297+ dependencies using [Poetry ][1] tool. The poetry automates definition, installation,
284298upgrades and the whole lifecycle of dependency in a project. All dependencies
285- are stored in `pyproject.toml` file in a groups that corresponds to individual
286- applications within the Operator pipelines project.
299+ are stored in `pyproject.toml` file.
287300
288301Adding, removing and updating of dependency needs to be always done
289- using `pdm ` cli.
302+ using `poetry ` cli.
290303
291304` ` ` bash
292- pdm add -G operator-pipelines gunicorn==20.1.0
305+ poetry add gunicorn==20.1.0
293306` ` `
294307
295- After a dependency is installed it is added to pdm .lock file. The lock file
308+ After a dependency is installed it is added to poetry .lock file. The lock file
296309is always part of git repository.
297310
298- If you want to install specific group set of dependencies use following command :
299-
300- ` ` ` bash
301- pdm install -G operator-pipelines
302- ` ` `
303-
304311Dependencies are stored into virtual environment (.venv) which is automatically
305- created after `pdm install`. If .venv wasn't created, configure pdm to
306- automatically create it during installation with `pdm config python.use_venv true`.
312+ created after `poetry install`. If .venv wasn't created, configure poetry to
313+ automatically create it during installation with `POETRY_VIRTUALENVS_IN_PROJECT= true`.
307314
308315# ## Run Unit Tests, Code Style Checkers, etc.
309316
@@ -314,9 +321,9 @@ Choose the preparation process according to your Linux version.
314321
315322` ` ` bash
316323sudo dnf -y install hadolint
317- python3 -m pip install pdm
318- pdm venv create 3 .13
319- pdm install
324+ python3 -m pip install poetry
325+ poetry env use python3 .13
326+ poetry install
320327source .venv/bin/activate
321328python3 -m pip install ansible-lint
322329` ` `
@@ -327,9 +334,9 @@ Before starting, make sure you have installed the [Brew][2] package manager.
327334
328335` ` ` bash
329336brew install hadolint
330- python3 -m pip install pdm
331- pdm venv create 3 .13
332- pdm install
337+ python3 -m pip install poetry
338+ poetry env use python3 .13
339+ poetry install
333340source .venv/bin/activate
334341python3 -m pip install ansible-lint
335342` ` `
@@ -344,11 +351,11 @@ tox
344351
345352# ## Local development
346353
347- Setup python virtual environment using pdm .
354+ Setup python virtual environment using poetry .
348355
349356` ` ` shell
350- pdm venv create 3 .13
351- pdm install
357+ poetry env use python3 .13
358+ poetry install
352359source .venv/bin/activate
353360` ` `
354361
@@ -375,5 +382,5 @@ source .venv/bin/activate
375382 buildah login quay.io
376383 ` ` `
377384
378- [1] : https://pdm.fming.dev/latest/
385+ [1] : https://python-poetry.org
379386[2] : https://brew.sh/
0 commit comments