Added example code for all api functions #949
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: Run oktoberfest Tests | |
| on: | |
| push: | |
| branches: | |
| - development | |
| - main | |
| - "release/*" | |
| pull_request: | |
| branches: | |
| - "*" | |
| jobs: | |
| tests: | |
| name: ${{ matrix.session }} ${{ matrix.python-version }} / ${{ matrix.os }} | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| include: | |
| - { | |
| python-version: 3.9, | |
| os: ubuntu-latest, | |
| session: "pre-commit", | |
| } | |
| - { | |
| python-version: 3.9, | |
| os: ubuntu-latest, | |
| session: "safety", | |
| } | |
| - { | |
| python-version: 3.9, | |
| os: ubuntu-latest, | |
| session: "mypy", | |
| } | |
| - { | |
| python-version: 3.9, | |
| os: ubuntu-latest, | |
| session: "tests", | |
| } | |
| - { | |
| python-version: 3.9, | |
| os: windows-latest, | |
| session: "tests", | |
| } | |
| - { | |
| python-version: 3.9, | |
| os: macos-latest, | |
| session: "tests", | |
| } | |
| - { | |
| python-version: 3.9, | |
| os: ubuntu-latest, | |
| session: "typeguard", | |
| } | |
| - { | |
| python-version: 3.9, | |
| os: ubuntu-latest, | |
| session: "xdoctest", | |
| } | |
| - { | |
| python-version: 3.9, | |
| os: ubuntu-latest, | |
| session: "docs-build", | |
| } | |
| env: | |
| NOXSESSION: ${{ matrix.session }} | |
| steps: | |
| - name: Check out the repository | |
| 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 | |
| run: | | |
| pipx install poetry | |
| poetry --version | |
| - name: Install nox nox-poetry rich | |
| run: | | |
| pipx install nox | |
| pipx inject nox nox-poetry | |
| pipx inject nox rich | |
| nox --version | |
| - name: Compute pre-commit cache key | |
| if: matrix.session == 'pre-commit' | |
| id: pre-commit-cache | |
| shell: python | |
| run: | | |
| import hashlib | |
| import sys | |
| python = "py{}.{}".format(*sys.version_info[:2]) | |
| payload = sys.version.encode() + sys.executable.encode() | |
| digest = hashlib.sha256(payload).hexdigest() | |
| result = "${{ runner.os }}-{}-{}-pre-commit".format(python, digest[:8]) | |
| print("::set-output name=result::{}".format(result)) | |
| - name: Restore pre-commit cache | |
| uses: actions/[email protected] | |
| if: matrix.session == 'pre-commit' | |
| with: | |
| path: ~/.cache/pre-commit | |
| key: ${{ steps.pre-commit-cache.outputs.result }}-${{ hashFiles('.pre-commit-config.yaml') }} | |
| restore-keys: | | |
| ${{ steps.pre-commit-cache.outputs.result }}- | |
| - name: Run Nox | |
| run: nox --force-color --python=${{ matrix.python-version }} | |
| - name: Upload coverage data | |
| if: always() && matrix.session == 'tests' && matrix.os == 'ubuntu-latest' | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: coverage-data | |
| path: ".coverage.*" | |
| - name: Upload documentation | |
| if: matrix.session == 'docs-build' | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: docs | |
| path: docs/_build | |
| coverage: | |
| runs-on: ubuntu-latest | |
| needs: tests | |
| steps: | |
| - name: Check out the repository | |
| uses: actions/checkout@v4 | |
| - name: Set up Python 3.8 | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: 3.8 | |
| - name: Install Poetry | |
| run: | | |
| pipx install poetry | |
| poetry --version | |
| - name: Install nox nox-poetry rich | |
| run: | | |
| pipx install nox | |
| pipx inject nox nox-poetry | |
| pipx inject nox rich | |
| nox --version | |
| - name: Download coverage data | |
| uses: actions/download-artifact@v4 | |
| with: | |
| name: coverage-data | |
| - name: Combine coverage data and display human readable report | |
| run: nox --force-color --session=coverage | |
| - name: Create coverage report | |
| run: nox --force-color --session=coverage -- xml -i | |
| - name: Upload coverage report | |
| uses: codecov/[email protected] |