Fix docstrings: missing sections and deprecated type patterns #322
This file contains hidden or 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: Test, Build, and Publish | |
| on: | |
| push: | |
| branches: | |
| - main | |
| - maint/* | |
| tags: | |
| - "*" | |
| pull_request: | |
| branches: | |
| - main | |
| - maint/* | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: true | |
| permissions: | |
| contents: read | |
| defaults: | |
| run: | |
| shell: bash | |
| jobs: | |
| quality: | |
| name: Code Quality | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4 | |
| - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5 | |
| with: | |
| python-version: "3.12" | |
| cache: pip | |
| - name: Install dependencies | |
| run: pip install -e .[dev] | |
| - name: Run ruff linting | |
| run: ruff check src/ --output-format=github | |
| - name: Run ruff formatting check | |
| run: ruff format --check src/ | |
| - name: Run mypy type checking | |
| run: mypy src/non_local_detector/ | |
| continue-on-error: true # Start lenient, can remove later | |
| test: | |
| name: Test Python ${{ matrix.python-version }} | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| python-version: ["3.10", "3.11", "3.12", "3.13"] | |
| steps: | |
| - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4 | |
| - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| cache: pip | |
| - name: Install dependencies | |
| run: pip install -e .[test] | |
| - name: Run tests | |
| run: pytest -v --cov=non_local_detector --cov-report=xml | |
| - name: Upload coverage to Codecov | |
| if: matrix.python-version == '3.12' | |
| uses: codecov/codecov-action@75cd11691c0faa626561e295848008c8a7dddffe # v5 | |
| with: | |
| token: ${{ secrets.CODECOV_TOKEN }} | |
| continue-on-error: true | |
| build: | |
| runs-on: ubuntu-latest | |
| needs: [quality, test] | |
| steps: | |
| - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4 | |
| with: | |
| fetch-depth: 0 | |
| - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5 | |
| with: | |
| python-version: "3.12" | |
| cache: pip | |
| - run: pip install build twine | |
| - name: Build sdist and wheel | |
| run: python -m build | |
| - run: twine check dist/* | |
| - name: Upload sdist and wheel artifacts | |
| uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4 | |
| with: | |
| name: dist | |
| path: dist/ | |
| - name: Build git archive | |
| run: mkdir archive && git archive -v -o archive/archive.tgz HEAD | |
| - name: Upload git archive artifact | |
| uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4 | |
| with: | |
| name: archive | |
| path: archive/ | |
| test-package: | |
| runs-on: ubuntu-latest | |
| needs: [build] | |
| strategy: | |
| matrix: | |
| package: ['wheel', 'sdist', 'archive'] | |
| steps: | |
| - name: Download sdist and wheel artifacts | |
| if: matrix.package != 'archive' | |
| uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4 | |
| with: | |
| name: dist | |
| path: dist/ | |
| - name: Download git archive artifact | |
| if: matrix.package == 'archive' | |
| uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4 | |
| with: | |
| name: archive | |
| path: archive/ | |
| - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5 | |
| with: | |
| python-version: "3.12" | |
| cache: pip | |
| - name: Install wheel | |
| if: matrix.package == 'wheel' | |
| run: pip install dist/*.whl | |
| - name: Install sdist | |
| if: matrix.package == 'sdist' | |
| run: pip install dist/*.tar.gz | |
| - name: Install archive | |
| if: matrix.package == 'archive' | |
| run: pip install archive/archive.tgz | |
| - name: Install test extras | |
| run: pip install non_local_detector[test] | |
| - name: Run tests | |
| run: pytest -v --pyargs non_local_detector | |
| publish: | |
| runs-on: ubuntu-latest | |
| needs: [test-package] | |
| if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/') | |
| permissions: | |
| id-token: write # Required for PyPI trusted publishing | |
| steps: | |
| - uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4 | |
| with: | |
| name: dist | |
| path: dist/ | |
| - uses: pypa/gh-action-pypi-publish@ed0c53931b1dc9bd32cbe73a98c7f6766f8a527e # release/v1 | |
| with: | |
| user: __token__ | |
| password: ${{ secrets.PYPI_API_TOKEN }} |