diff --git a/.github/workflows/coverage.yaml b/.github/workflows/coverage.yaml new file mode 100644 index 00000000..b3e9ca2a --- /dev/null +++ b/.github/workflows/coverage.yaml @@ -0,0 +1,60 @@ +name: "piel-coverage" + +on: + workflow_dispatch: + workflow_run: + workflows: [ "piel-tests" ] + types: + - completed + +defaults: + run: + shell: bash + +env: + PIP_DISABLE_PIP_VERSION_CHECK: 1 + FORCE_COLOR: 1 # Get colored pytest output + +permissions: + contents: read + +jobs: + build: + name: Coverage Test + runs-on: ubuntu-latest + defaults: + run: + shell: bash + env: # Set environment variables for the whole job + PIP_ONLY_BINARY: gdstk + MPLBACKEND: agg + steps: + - uses: actions/checkout@v1 + - name: Set up Python 3.10 + uses: actions/setup-python@v2 + with: + python-version: "3.10" + #---------------------------------------------- + # ----- install & configure poetry ----- + #---------------------------------------------- + - name: Install Poetry + uses: snok/install-poetry@v1 + with: + version: 1.8.2 + virtualenvs-create: true + virtualenvs-in-project: true + #---------------------------------------------- + # install dependencies if cache does not exist + #---------------------------------------------- + - name: Install dependencies + run: poetry install -E dev + #---------------------------------------------- + # add matrix specifics and run test suite + #---------------------------------------------- + - name: Run tests + run: | + source $VENV + coverage run -m pytest -rA tests + coverage report -m + echo "total=$(coverage report --format=total)" >> $GITHUB_ENV + echo '### Total coverage: ${{ env.total }}%' diff --git a/docs/sections/environment/installation.rst b/docs/sections/environment/installation.rst index a68872bc..21e109a8 100644 --- a/docs/sections/environment/installation.rst +++ b/docs/sections/environment/installation.rst @@ -30,6 +30,12 @@ You can either clone the public repository: $ git clone git://github.com/daquintero/piel +If you are using Windows, you might have to run this too: + +.. code:: bash + + git config --global core.longpaths true + Or download the `tarball `__: @@ -55,12 +61,13 @@ Developer’s Requirements You might also need to run the following commands to run the examples, documentation, and full environment: -:: +.. code:: bash mamba install pandoc mamba install jupyterlab jupytext poetry install -E dev + Usage -----