chore: Update CI workflow to output test reports on failure #10
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 | |
| on: | |
| push: | |
| branches: | |
| - main | |
| paths-ignore: | |
| - ".gitignore" | |
| - "README.rst" | |
| pull_request: | |
| paths-ignore: | |
| - ".gitignore" | |
| - "README.rst" | |
| permissions: | |
| contents: read | |
| jobs: | |
| build-package: | |
| runs-on: ubuntu-latest | |
| concurrency: | |
| group: ${{ github.event_name }}-${{ github.workflow }}-${{ github.ref_name }}-build | |
| cancel-in-progress: true | |
| timeout-minutes: 20 | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| fetch-tags: true | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.12" | |
| cache: pip | |
| cache-dependency-path: | | |
| setup.py | |
| **/*requirements.txt | |
| tox.ini | |
| - run: make setup-ci | |
| - run: make build | |
| - uses: actions/upload-artifact@v4 | |
| with: | |
| name: dist | |
| path: ./dist/* | |
| publish-package: | |
| needs: build-package | |
| runs-on: ubuntu-latest | |
| concurrency: | |
| group: ${{ github.event_name }}-${{ github.workflow }}-${{ github.ref_name }}-publish-pkg | |
| cancel-in-progress: true | |
| timeout-minutes: 10 | |
| environment: | |
| name: testpypi | |
| url: https://pypi.org/p/pathvalidate-cli | |
| permissions: | |
| id-token: write # IMPORTANT: this permission is mandatory for trusted publishing | |
| steps: | |
| - uses: actions/download-artifact@v4 | |
| with: | |
| name: dist | |
| path: ./dist | |
| - name: Publish package to TestPyPI | |
| uses: pypa/gh-action-pypi-publish@release/v1 | |
| with: | |
| repository-url: https://test.pypi.org/legacy/ | |
| skip-existing: true | |
| sign-package: | |
| needs: publish-package | |
| runs-on: ubuntu-latest | |
| concurrency: | |
| group: ${{ github.event_name }}-${{ github.workflow }}-${{ github.ref_name }}-sign-pkg | |
| cancel-in-progress: true | |
| timeout-minutes: 10 | |
| permissions: | |
| id-token: write | |
| steps: | |
| - uses: actions/download-artifact@v4 | |
| with: | |
| name: dist | |
| path: ./dist | |
| - name: Sign the dists with Sigstore | |
| uses: sigstore/gh-action-sigstore-python@v2.1.1 | |
| with: | |
| inputs: >- | |
| ./dist/*.tar.gz | |
| ./dist/*.whl | |
| - uses: actions/upload-artifact@v4 | |
| with: | |
| name: sigstore | |
| path: ./dist/* | |
| lint: | |
| runs-on: ubuntu-latest | |
| concurrency: | |
| group: ${{ github.event_name }}-${{ github.workflow }}-${{ github.ref_name }}-lint | |
| cancel-in-progress: true | |
| timeout-minutes: 20 | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| fetch-tags: true | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.12" | |
| cache: pip | |
| cache-dependency-path: | | |
| setup.py | |
| **/*requirements.txt | |
| tox.ini | |
| - run: make setup-ci | |
| - run: make check | |
| unit-test: | |
| runs-on: ${{ matrix.os }} | |
| concurrency: | |
| group: ${{ github.event_name }}-${{ github.workflow }}-${{ github.ref_name }}-ut-${{ matrix.os }}-${{ matrix.python-version }} | |
| cancel-in-progress: true | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| python-version: ["3.8", "3.9", "3.10", "3.11"] | |
| os: [ubuntu-latest, macos-latest, windows-latest] | |
| timeout-minutes: 20 | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Setup Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| cache: pip | |
| cache-dependency-path: | | |
| **/*requirements.txt | |
| setup.py | |
| tox.ini | |
| - run: make setup-ci | |
| - name: Run tests | |
| env: | |
| REPORT_OUTPUT: md_report.md | |
| run: | | |
| echo "REPORT_FILE=${REPORT_OUTPUT}" >> "$GITHUB_ENV" | |
| tox -e py -- --md-report-output "${REPORT_OUTPUT}" | |
| - name: Output reports to the job summary when tests fail | |
| if: failure() && matrix.os != 'ubuntu-latest' | |
| run: | | |
| if [ -f "$REPORT_FILE" ]; then | |
| echo "<details><summary>Failed Test Report</summary>" >> $GITHUB_STEP_SUMMARY | |
| echo "" >> $GITHUB_STEP_SUMMARY | |
| cat "$REPORT_FILE" >> $GITHUB_STEP_SUMMARY | |
| echo "" >> $GITHUB_STEP_SUMMARY | |
| echo "</details>" >> $GITHUB_STEP_SUMMARY | |
| else | |
| echo "No failed tests to report" | |
| fi |