Add docstring and unit tests for make voxels array task #74
Workflow file for this run
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
| name: lint | |
| on: [push] | |
| jobs: | |
| lint: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout the repo | |
| uses: actions/checkout@v4 | |
| - name: Set up Python 3.9 | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: 3.9 | |
| - name: Install poetry | |
| uses: snok/install-poetry@v1 | |
| with: | |
| virtualenvs-create: true | |
| virtualenvs-in-project: true | |
| - name: Cache environment | |
| id: cached-dependencies | |
| uses: actions/cache@v4 | |
| with: | |
| path: .venv | |
| key: ${{ runner.os }}-${{ hashFiles('**/poetry.lock') }} | |
| - name: Install dependencies | |
| if: steps.cached-dependencies.outputs.cache-hit != 'true' | |
| run: | | |
| poetry install --no-interaction --no-root | |
| - name: Lint with pylint | |
| run: | | |
| source .venv/bin/activate | |
| pylint --ignore-patterns=test.*?py src/ tests/ --fail-under=7.0 | |
| - name: Check with black | |
| run: | | |
| source .venv/bin/activate | |
| black -l 100 --check src/ tests/ | |
| - name: Check with isort | |
| run: | | |
| source .venv/bin/activate | |
| isort -l 100 --check src/ tests/ | |
| - name: Check with mypy | |
| run: | | |
| source .venv/bin/activate | |
| mypy src | |
| result: | |
| if: ${{ always() && github.ref == 'refs/heads/main' }} | |
| runs-on: ubuntu-latest | |
| needs: [lint] | |
| steps: | |
| - name: Checkout the repo | |
| uses: actions/checkout@v4 | |
| - name: Get lint result | |
| run: | | |
| if [[ ${{ needs.lint.result }} == "success" || ${{ needs.lint.result }} == "skipped" ]]; then | |
| exit 0 | |
| else | |
| exit 1 | |
| fi | |
| - name: Generate passing badge | |
| if: success() | |
| uses: knightdave/anybadge-action@v1.1.0 | |
| with: | |
| file: docs/_badges/lint.svg | |
| label: lint | |
| value: passing | |
| color: green | |
| template: docs/_badges/template.svg | |
| overwrite: true | |
| - name: Generate failing badge | |
| if: failure() | |
| uses: knightdave/anybadge-action@v1.1.0 | |
| with: | |
| file: docs/_badges/lint.svg | |
| label: lint | |
| value: failing | |
| color: red | |
| template: docs/_badges/template.svg | |
| overwrite: true | |
| - name: Publish badge | |
| if: success() || failure() | |
| uses: JamesIves/github-pages-deploy-action@v4 | |
| with: | |
| branch: gh-pages | |
| folder: docs/_badges | |
| target-folder: _badges | |
| clean: false |