add docs #17
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
| # This workflow will install Python dependencies, run tests and lint with a single version of Python | |
| # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions | |
| name: Check | |
| on: | |
| push: {} | |
| pull_request: {} | |
| env: | |
| PYTHON_VERSION: 3.11.8 | |
| PYTHONUNBUFFERED: 1 | |
| jobs: | |
| tests: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v4 | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ env.PYTHON_VERSION }} | |
| cache: "pip" | |
| - name: Install dependencies | |
| run: | | |
| pip install hatch | |
| - name: Run tests | |
| run: | | |
| hatch run test | |
| - uses: codecov/codecov-action@v4 | |
| if: ${{ github.event_name == 'pull_request' || github.repository == 'breatheco-de/apiv2' }} | |
| with: | |
| token: ${{ secrets.CODECOV_TOKEN }} # not required for public repos | |
| files: ./coverage.xml # optional | |
| flags: unittests # optional | |
| name: codecov-umbrella # optional | |
| fail_ci_if_error: true # optional (default = false) | |
| verbose: true # optional (default = false) | |
| - name: Upload coverage data to coveralls.io | |
| if: ${{ github.event_name == 'pull_request' || github.repository == 'breatheco-de/apiv2' }} | |
| run: | | |
| hatch run coveralls --service=github | |
| env: | |
| GITHUB_TOKEN: ${{ github.token }} | |
| pages: | |
| if: >- | |
| github.repository == 'breatheco-de/linked-services-django-plugin' && | |
| github.event_name == 'push' && | |
| github.ref == 'refs/heads/main' | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v4 | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ env.PYTHON_VERSION }} | |
| cache: "pip" | |
| - name: Install dependencies | |
| run: | | |
| pip install hatch | |
| - name: Deploy docs | |
| run: hatch run mkdocs gh-deploy --force |