Merge pull request #523 from plannigan/renovate/mkdocstrings-0.x #1409
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: CI | |
| # Workflow does NOT trigger on a feature branch until a pull request is created. | |
| # Workflow will always run when a pull request is merged to the default branch. | |
| on: | |
| pull_request: {} | |
| push: | |
| branches: ["main"] | |
| env: | |
| PYTHON_VERSION: "3.11" | |
| jobs: | |
| bandit: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Check out code | |
| uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3.6.0 | |
| - uses: actions/setup-python@61a6322f88396a6271a6ee3565807d608ecaddd1 # v4.7.0 | |
| with: | |
| python-version: ${{ env.PYTHON_VERSION }} | |
| - name: Install dependencies | |
| uses: ./.github/actions/install-dependencies | |
| with: | |
| test-requirements: "true" | |
| - name: Run bandit | |
| run: bandit --ini .bandit -r columbo | |
| black: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Check out code | |
| uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3.6.0 | |
| - name: Set up Python | |
| uses: actions/setup-python@61a6322f88396a6271a6ee3565807d608ecaddd1 # v4.7.0 | |
| with: | |
| python-version: ${{ env.PYTHON_VERSION }} | |
| - name: Install dependencies | |
| uses: ./.github/actions/install-dependencies | |
| with: | |
| test-requirements: "true" | |
| - name: Run black | |
| run: black --check columbo tests | |
| flake8: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Check out code | |
| uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3.6.0 | |
| - uses: actions/setup-python@61a6322f88396a6271a6ee3565807d608ecaddd1 # v4.7.0 | |
| with: | |
| python-version: ${{ env.PYTHON_VERSION }} | |
| - name: Install dependencies | |
| uses: ./.github/actions/install-dependencies | |
| with: | |
| test-requirements: "true" | |
| - name: Run flake8 | |
| run: flake8 columbo tests | |
| isort: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Check out code | |
| uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3.6.0 | |
| - uses: actions/setup-python@61a6322f88396a6271a6ee3565807d608ecaddd1 # v4.7.0 | |
| with: | |
| python-version: ${{ env.PYTHON_VERSION }} | |
| - name: Install dependencies | |
| uses: ./.github/actions/install-dependencies | |
| with: | |
| requirements: "true" | |
| test-requirements: "true" | |
| - name: Run isort | |
| run: isort --recursive --check-only columbo tests | |
| mypy: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Check out code | |
| uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3.6.0 | |
| - uses: actions/setup-python@61a6322f88396a6271a6ee3565807d608ecaddd1 # v4.7.0 | |
| with: | |
| python-version: ${{ env.PYTHON_VERSION }} | |
| - name: Install dependencies | |
| uses: ./.github/actions/install-dependencies | |
| with: | |
| requirements: "true" | |
| test-requirements: "true" | |
| - name: Run mypy | |
| run: mypy columbo tests | |
| renovate: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3.6.0 | |
| - name: 🧼 lint renovate config # Validates changes to renovate.json config file | |
| uses: suzuki-shunsuke/github-action-renovate-config-validator@b7cd2b598bb51d071a2474e98f55cc25f91abec1 # v0.1.3 | |
| with: | |
| config_file_path: 'renovate.json' | |
| test: | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| python-version: ["3.8", "3.9", "3.10", "3.11"] | |
| steps: | |
| - name: Check out code | |
| uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3.6.0 | |
| - uses: actions/setup-python@61a6322f88396a6271a6ee3565807d608ecaddd1 # v4.7.0 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Install dependencies | |
| uses: ./.github/actions/install-dependencies | |
| with: | |
| requirements: "true" | |
| test-requirements: "true" | |
| - name: Run pytest | |
| run: pytest --cov-report xml:coverage-${{ matrix.python-version }}.xml --junitxml=test-results-${{ matrix.python-version }}.xml | |
| - name: Upload pytest test results artifact | |
| uses: actions/upload-artifact@0b7f8abb1508181956e8e162db84b466c27e18ce # v3 | |
| with: | |
| name: pytest-results-${{ matrix.python-version }} | |
| path: test-results-${{ matrix.python-version }}.xml | |
| # Use always() to always run this step to publish test results when there are test failures | |
| if: ${{ always() }} | |
| - name: Upload coverage results artifact | |
| uses: actions/upload-artifact@0b7f8abb1508181956e8e162db84b466c27e18ce # v3 | |
| with: | |
| name: pytest-coverage-${{ matrix.python-version }} | |
| path: coverage-${{ matrix.python-version }}.xml | |
| # Use always() to always run this step to publish test results when there are test failures | |
| if: ${{ always() }} | |
| - name: Publish coverage results to Codecov | |
| uses: codecov/codecov-action@eaaf4bedf32dbdc6b720b63067d99c4d77d6047d # v3.1.4 | |
| with: | |
| file: coverage-${{ matrix.python-version }}.xml | |
| fail_ci_if_error: true | |
| token: ${{ secrets.CODECOV_TOKEN }} | |
| verify-wheel: | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| python-version: ["3.8", "3.9", "3.10", "3.11"] | |
| steps: | |
| - name: Check out code | |
| uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3.6.0 | |
| - uses: actions/setup-python@61a6322f88396a6271a6ee3565807d608ecaddd1 # v4.7.0 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Build wheel | |
| uses: ./.github/actions/build-dist | |
| - name: Verify wheel | |
| uses: ./.github/actions/verify-wheel | |
| with: | |
| package-import-name: "columbo" | |
| validate-doc-examples: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Check out code | |
| uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3.6.0 | |
| - name: Validate docs | |
| run: ./docker/validate_docs.sh | |
| build-docs: | |
| runs-on: ubuntu-latest | |
| if: github.event_name == 'pull_request' | |
| steps: | |
| - name: Check out code | |
| uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3.6.0 | |
| - uses: actions/setup-python@61a6322f88396a6271a6ee3565807d608ecaddd1 # v4.7.0 | |
| with: | |
| python-version: ${{ env.PYTHON_VERSION }} | |
| - name: Install dependencies | |
| uses: ./.github/actions/install-dependencies | |
| with: | |
| requirements: "true" | |
| docs-requirements: "true" | |
| - name: Build Docs | |
| run: mkdocs build --strict | |
| - name: Upload coverage results artifact | |
| uses: actions/upload-artifact@0b7f8abb1508181956e8e162db84b466c27e18ce # v3 | |
| with: | |
| name: docs-site | |
| path: site/ | |
| update-dev-docs: | |
| runs-on: ubuntu-latest | |
| if: github.event_name == 'push' && github.ref == 'refs/heads/main' | |
| steps: | |
| - name: Check out code | |
| uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3.6.0 | |
| - uses: actions/setup-python@61a6322f88396a6271a6ee3565807d608ecaddd1 # v4.7.0 | |
| with: | |
| python-version: ${{ env.PYTHON_VERSION }} | |
| - name: Install dependencies | |
| uses: ./.github/actions/install-dependencies | |
| with: | |
| requirements: "true" | |
| docs-requirements: "true" | |
| - name: Push documentation changes | |
| uses: ./.github/actions/publish-docs-with-mike | |
| with: | |
| version_name: dev |