diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 7df5905f03a108cfdcb2ee8f84f77954e31f755f..a39700f45ba2d88ca87545cc25b2b9a7cdeab53d 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -10,8 +10,8 @@ cache: # before_script is used to define the command that should be run before all jobs, including deploy jobs, but after the restoration of artifacts. # This can be an array or a multi-line string. before_script: - - pip install pipenv - - pipenv install + - python3 -m pip install -r docker-requirements.txt + stages: - test @@ -29,7 +29,8 @@ test: # tags: # - docker-executor script: - - pipenv run python setup.py test + # - pipenv run python setup.py test + - python3 setup.py test - mv coverage.xml ./build/reports/code-coverage.xml artifacts: paths: @@ -39,11 +40,14 @@ test: list_dependencies: stage: test script: - - pipenv graph >> pipenv_deps.txt + # - pipenv graph >> pipenv_deps.txt + - pipdeptree --json >> pip_deps.json + - pipdeptree >> pip_deps.txt - dpkg -l >> system_deps.txt - awk 'FNR>5 {print $2 ", " $3}' system_deps.txt >> system_deps.csv - mkdir .public - - cp pipenv_deps.txt .public/ + - cp pip_deps.txt .public/ + - cp pip_deps.json .public/ - cp system_deps.txt .public/ - cp system_deps.csv .public/ - mv .public public diff --git a/README.md b/README.md index fb516253ce59bf3d32db97bca14dda9eb7f55961..94e87282c993f831eb41e4861abb141f39354eb9 100644 --- a/README.md +++ b/README.md @@ -14,9 +14,9 @@ Install ------- **Always** use a virtual environment. [Pipenv](https://pipenv.readthedocs.io/en/latest/) is now Python's officially -recommended method and the one used by default in this repo. +recommended method, but we are not using it for installing requirements when building on the CI Pipeline. You are encouraged to use your preferred environment isolation (i.e. `pip`, `conda` or `pipenv` while developing locally. -Follow these steps at the project root: +For working with `Pipenv`, follow these steps at the project root: First, ensure that `~/.local/bin` is in your `PATH` with: ```bash diff --git a/docker-requirements.txt b/docker-requirements.txt index 6d09930468d41b4f83966b81e0974104b1ee7453..040cecbfef9cfaef9896136256805468d4f361b8 100644 --- a/docker-requirements.txt +++ b/docker-requirements.txt @@ -11,4 +11,6 @@ sphinx sphinx_rtd_theme sphinx-autobuild sphinx-rtd-theme -sphinxcontrib-websupport \ No newline at end of file +sphinxcontrib-websupport +pipdeptree +pylint_junit \ No newline at end of file diff --git a/docs/src/index.rst b/docs/src/index.rst index 3443f7b2002e69d06128b18a037ffe7ac7730d02..30526882f71f8d4468b8e40bc640379496b9c70e 100644 --- a/docs/src/index.rst +++ b/docs/src/index.rst @@ -22,7 +22,7 @@ :maxdepth: 2 :caption: Readme - README + ../../README .. COMMUNITY SECTION ================================================== @@ -30,14 +30,14 @@ .. toctree:: :maxdepth: 2 - :caption: Package-name + :caption: Package name :hidden: package/guide -Project-name documentation -========================== +Project-name documentation HEADING +================================== These are all the packages, functions and scripts that form part of the project.