✨ Add support for rich_help_panel of commands in generated docs #1668
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: Test | |
| on: | |
| push: | |
| branches: | |
| - master | |
| pull_request: | |
| types: | |
| - opened | |
| - synchronize | |
| schedule: | |
| # cron every week on monday | |
| - cron: "0 0 * * 1" | |
| jobs: | |
| test: | |
| strategy: | |
| matrix: | |
| os: [ ubuntu-latest, windows-latest, macos-latest ] | |
| python-version: [ "3.12" ] | |
| include: | |
| - os: ubuntu-latest | |
| python-version: "3.7" | |
| - os: macos-latest | |
| python-version: "3.8" | |
| - os: windows-latest | |
| python-version: "3.9" | |
| - os: ubuntu-latest | |
| python-version: "3.10" | |
| - os: macos-latest | |
| python-version: "3.11" | |
| fail-fast: false | |
| runs-on: ${{ matrix.os }} | |
| steps: | |
| - name: Dump GitHub context | |
| env: | |
| GITHUB_CONTEXT: ${{ toJson(github) }} | |
| run: echo "$GITHUB_CONTEXT" | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| # Issue ref: https://github.com/actions/setup-python/issues/436 | |
| # cache: "pip" | |
| # cache-dependency-path: pyproject.toml | |
| - uses: actions/cache@v4 | |
| if: ${{ runner.os != 'macOS' }} | |
| id: cache | |
| with: | |
| path: ${{ env.pythonLocation }} | |
| key: ${{ runner.os }}-python-${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml', 'requirements-tests.txt') }} | |
| - name: Install Dependencies | |
| if: steps.cache.outputs.cache-hit != 'true' | |
| run: pip install -r requirements-tests.txt | |
| - name: Lint | |
| run: bash scripts/lint.sh | |
| - run: mkdir coverage | |
| - run: bash ./scripts/test-files.sh | |
| - name: Test | |
| run: bash scripts/test.sh | |
| env: | |
| COVERAGE_FILE: coverage/.coverage.${{ runner.os }}-py${{ matrix.python-version }} | |
| CONTEXT: ${{ runner.os }}-py${{ matrix.python-version }} | |
| - name: Store coverage files | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: coverage-${{ runner.os }}-${{ matrix.python-version }} | |
| path: coverage | |
| coverage-combine: | |
| needs: [test] | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Dump GitHub context | |
| env: | |
| GITHUB_CONTEXT: ${{ toJson(github) }} | |
| run: echo "$GITHUB_CONTEXT" | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.8' | |
| # Issue ref: https://github.com/actions/setup-python/issues/436 | |
| # cache: "pip" | |
| # cache-dependency-path: pyproject.toml | |
| - name: Get coverage files | |
| uses: actions/download-artifact@v4 | |
| with: | |
| pattern: coverage-* | |
| path: coverage | |
| merge-multiple: true | |
| - run: pip install coverage[toml] | |
| - run: ls -la coverage | |
| - run: coverage combine coverage | |
| - run: coverage report | |
| - run: coverage html --show-contexts --title "Coverage for ${{ github.sha }}" | |
| - name: Store coverage HTML | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: coverage-html | |
| path: htmlcov | |
| # https://github.com/marketplace/actions/alls-green#why | |
| check: # This job does nothing and is only used for the branch protection | |
| if: always() | |
| needs: | |
| - coverage-combine | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Dump GitHub context | |
| env: | |
| GITHUB_CONTEXT: ${{ toJson(github) }} | |
| run: echo "$GITHUB_CONTEXT" | |
| - name: Decide whether the needed jobs succeeded or failed | |
| uses: re-actors/alls-green@release/v1 | |
| with: | |
| jobs: ${{ toJSON(needs) }} |