Add docs for plot contact sheet task #89
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: build | |
| on: [push] | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| python-version: ["3.9", "3.10"] | |
| steps: | |
| - name: Checkout the repo | |
| uses: actions/checkout@v4 | |
| - name: Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - 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: Install library | |
| run: | | |
| poetry install --no-interaction | |
| - name: Test with pytest | |
| run: | | |
| source .venv/bin/activate | |
| pytest --cov-report html --cov=src/ tests/ | |
| rm htmlcov/.gitignore | |
| - name: Publish coverage report | |
| if: ${{ github.ref == 'refs/heads/main' && matrix.python-version == '3.10' }} | |
| uses: JamesIves/github-pages-deploy-action@v4 | |
| with: | |
| branch: gh-pages | |
| folder: htmlcov | |
| target-folder: _coverage | |
| - name: Extract coverage percent | |
| if: ${{ github.ref == 'refs/heads/main' && matrix.python-version == '3.10' }} | |
| run: | | |
| echo "COVERAGE=$(grep -oP 'pc_cov">\K([0-9]+)' htmlcov/index.html)" >> $GITHUB_ENV | |
| - name: Generate coverage badge | |
| if: ${{ github.ref == 'refs/heads/main' && matrix.python-version == '3.10' }} | |
| uses: knightdave/anybadge-action@v1.1.0 | |
| with: | |
| file: docs/_badges/coverage.svg | |
| label: coverage | |
| value: ${{ env.COVERAGE }} | |
| value_format: "%d%%" | |
| anybadge_args: 50=red 60=orange 80=yellow 100=green | |
| template: docs/_badges/template.svg | |
| overwrite: true | |
| - name: Publish badge | |
| if: ${{ github.ref == 'refs/heads/main' && matrix.python-version == '3.10' }} | |
| uses: JamesIves/github-pages-deploy-action@v4 | |
| with: | |
| branch: gh-pages | |
| folder: docs/_badges | |
| target-folder: _badges | |
| clean: false | |
| result: | |
| if: ${{ always() && github.ref == 'refs/heads/main' }} | |
| runs-on: ubuntu-latest | |
| needs: [build] | |
| steps: | |
| - name: Checkout the repo | |
| uses: actions/checkout@v4 | |
| - name: Get build result | |
| run: | | |
| if [[ ${{ needs.build.result }} == "success" || ${{ needs.build.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/build.svg | |
| label: build | |
| 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/build.svg | |
| label: build | |
| 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 |