Add design considerations #184
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: Verify | |
| on: [push, pull_request] | |
| jobs: | |
| lint: | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| matrix: | |
| python: ['3.12'] | |
| os: [ubuntu-latest] | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python }} | |
| # Install dependencies. | |
| - uses: actions/cache@v4 | |
| name: Python cache with dependencies. | |
| id: python-cache | |
| with: | |
| path: ${{ env.pythonLocation }} | |
| key: ${{ env.pythonLocation }}-${{ matrix.os }}-${{ matrix.python }}-${{ hashFiles('pyproject.toml') }} | |
| - name: Install dependencies. | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install -e .[dev] | |
| pip list | |
| # Linter. | |
| - run: ruff check pyodk tests docs --no-fix | |
| - run: ruff format pyodk tests docs --diff | |
| test: | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| # Run all matrix jobs even if one of them fails. | |
| fail-fast: false | |
| matrix: | |
| python: ['3.12'] | |
| os: [ubuntu-latest, macos-latest, windows-latest] | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python }} | |
| # Install dependencies. | |
| - uses: actions/cache@v4 | |
| name: Python cache with dependencies. | |
| id: python-cache | |
| with: | |
| path: ${{ env.pythonLocation }} | |
| key: ${{ env.pythonLocation }}-${{ matrix.os }}-${{ matrix.python }}-${{ hashFiles('pyproject.toml') }} | |
| - name: Install dependencies. | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install -e .[dev,docs] | |
| pip list | |
| # Tests. | |
| - name: Run tests | |
| run: python -m unittest --verbose | |
| # Build and Upload. | |
| - name: Build sdist and wheel. | |
| if: success() | |
| run: | | |
| pip install flit==3.9.0 | |
| flit --debug build --no-use-vcs | |
| - name: Upload sdist and wheel. | |
| if: success() | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: pyodk--on-${{ matrix.os }}--py${{ matrix.python }} | |
| path: ${{ github.workspace }}/dist/pyodk* | |
| # Check docs. | |
| - name: Check docs | |
| run: mkdocs build --strict |