Documentation #400
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
| # GitHub Actions configuration **EXAMPLE**, | |
| # MODIFY IT ACCORDING TO YOUR NEEDS! | |
| # Reference: https://docs.github.com/en/actions | |
| name: tests | |
| on: | |
| push: | |
| # Avoid using all the resources/limits available by checking only | |
| # relevant branches and tags. Other branches can be checked via PRs. | |
| branches: [main] | |
| tags: ['v[0-9]*', '[0-9]+.[0-9]+*'] # Match tags that resemble a version | |
| pull_request: | |
| types: [opened, synchronize, reopened, labeled, unlabeled] | |
| workflow_dispatch: # Allow manually triggering the workflow | |
| permissions: | |
| id-token: write | |
| contents: write | |
| pull-requests: write | |
| concurrency: | |
| group: >- | |
| ${{ github.workflow }}-${{ github.ref_type }}- | |
| ${{ github.event.pull_request.number || github.sha }} | |
| cancel-in-progress: true | |
| jobs: | |
| prepare: | |
| runs-on: ubuntu-latest | |
| outputs: | |
| wheel-distribution: ${{ steps.wheel-distribution.outputs.path }} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: {fetch-depth: 0} # deep clone for setuptools-scm | |
| - uses: actions/setup-python@v5 | |
| id: setup-python | |
| with: {python-version: "3.11"} | |
| - name: Run static analysis and format checkers | |
| run: pipx run pre-commit run --all-files --show-diff-on-failure | |
| - name: Build package distribution files | |
| run: >- | |
| pipx run --python '${{ steps.setup-python.outputs.python-path }}' | |
| tox -e clean,build | |
| - name: Record the path of wheel distribution | |
| id: wheel-distribution | |
| run: echo "path=$(ls dist/*.whl)" >> $GITHUB_OUTPUT | |
| - name: Store the distribution files for use in other stages | |
| # `tests` and `publish` will use the same pre-built distributions, | |
| # so we make sure to release the exact same package that was tested | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: python-distribution-files | |
| path: dist/ | |
| retention-days: 1 | |
| test: | |
| needs: prepare | |
| strategy: | |
| matrix: | |
| python: | |
| - "3.8" # oldest Python supported by PSF | |
| - "3.11" # newest Python that is stable | |
| platform: | |
| - ubuntu-latest | |
| - macos-15 | |
| - windows-latest | |
| runs-on: ${{ matrix.platform }} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v5 | |
| id: setup-python | |
| with: | |
| python-version: ${{ matrix.python }} | |
| - name: Retrieve pre-built distribution files | |
| uses: actions/download-artifact@v4 | |
| with: {name: python-distribution-files, path: dist/} | |
| - name: Run tests | |
| run: >- | |
| pipx run --python '${{ steps.setup-python.outputs.python-path }}' | |
| tox --installpkg '${{ needs.prepare.outputs.wheel-distribution }}' | |
| -- -rFEx --durations 10 --color yes # pytest args | |
| - name: Generate coverage report | |
| run: pipx run coverage lcov -o coverage.lcov | |
| - name: Upload partial coverage report | |
| uses: coverallsapp/github-action@main | |
| if: ${{ matrix.platform != 'macos-12' }} | |
| with: | |
| path-to-lcov: coverage.lcov | |
| github-token: ${{ secrets.GITHUB_TOKEN }} | |
| flag-name: ${{ matrix.platform }} - py${{ matrix.python }} | |
| parallel: true | |
| - name: Save coverage report | |
| if: ${{ matrix.platform == 'ubuntu-latest' && matrix.python == '3.11' }} | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: coverage | |
| path: htmlcov | |
| finalize: | |
| needs: test | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Finalize coverage report | |
| uses: coverallsapp/github-action@main | |
| with: | |
| github-token: ${{ secrets.GITHUB_TOKEN }} | |
| parallel-finished: true | |
| benchmark: | |
| needs: finalize | |
| runs-on: ubuntu-latest | |
| if: ${{ github.event_name != 'push' && ! contains(github.ref, 'refs/tags/') }} | |
| steps: | |
| - uses: actions/create-github-app-token@v1 | |
| id: github-app | |
| with: | |
| app-id: ${{ secrets.BOT_GITHUB_APP_ID }} | |
| private-key: ${{ secrets.BOT_GITHUB_APP_PRIVATE_KEY }} | |
| owner: ${{ github.repository_owner }} | |
| repositories: | | |
| foapy-asv-results | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - uses: actions/checkout@v4 | |
| with: | |
| repository: intervals-mining-lab/foapy-asv-results | |
| path: benchmarks/results | |
| ref: main | |
| fetch-depth: 0 | |
| token: ${{ steps.github-app.outputs.token }} | |
| - uses: actions/setup-python@v5 | |
| id: setup-python | |
| with: {python-version: "3.11"} | |
| - name: Install ASV | |
| run: |- | |
| pipx install --python '${{ steps.setup-python.outputs.python-path }}' asv virtualenv build | |
| - name: Checkout benchmark results | |
| run: |- | |
| cd ./benchmarks/results | |
| git pull | |
| git checkout -b ${{ github.event.pull_request.head.ref }} --track origin/${{ github.event.pull_request.base.ref }} || true | |
| - name: Run benchmark | |
| id: benchmark | |
| env: | |
| QUICK_BENCHMARK: ${{ ! contains( github.event.pull_request.labels.*.name, 'benchmark') }} | |
| run: |- | |
| cd ./benchmarks | |
| asv machine --yes || true | |
| asv setup -v || true | |
| asv continuous ${{ github.event.pull_request.base.sha }} HEAD || true | |
| REPORT=$(asv compare ${{ github.event.pull_request.base.sha }} HEAD --split --only-changed) | |
| echo "${REPORT}" >> $GITHUB_STEP_SUMMARY | |
| REPORT="${REPORT}" | |
| echo 'REPORT_RESULT<<EOF' >> $GITHUB_ENV | |
| echo "${REPORT}" >> $GITHUB_ENV | |
| echo 'EOF' >> $GITHUB_ENV | |
| asv publish | |
| cd ./results | |
| git config user.email "[email protected]" | |
| git config user.name "ci-bot" | |
| git add . | |
| git commit -m "Update benchmark results" | |
| - name: Push changes | |
| uses: ad-m/github-push-action@master | |
| with: | |
| github_token: ${{ steps.github-app.outputs.token }} | |
| repository: intervals-mining-lab/foapy-asv-results | |
| branch: ${{ github.event.pull_request.head.ref }} | |
| directory: benchmarks/results | |
| - uses: mshick/add-pr-comment@v2 | |
| if: ${{ env.REPORT_RESULT != '' }} | |
| with: | |
| message: |- | |
| ${{ env.REPORT_RESULT }} | |
| - name: Save benchmark report | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: benchmark | |
| path: benchmarks/html | |
| docs: | |
| needs: benchmark | |
| runs-on: ubuntu-latest | |
| env: | |
| GIT_COMMITTER_NAME: ci-bot | |
| GIT_COMMITTER_EMAIL: [email protected] | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: {fetch-depth: 0} # deep clone for setuptools-scm | |
| - uses: actions/setup-python@v5 | |
| id: setup-python | |
| with: {python-version: "3.11"} | |
| - name: Retrieve coverage report | |
| uses: actions/download-artifact@v4 | |
| with: | |
| name: coverage | |
| path: htmlcovs | |
| - name: Retrieve benchmark report | |
| uses: actions/download-artifact@v4 | |
| with: | |
| name: benchmark | |
| path: benchmarks/html | |
| - name: Setup Pages | |
| uses: actions/configure-pages@v5 | |
| - name: Build package distribution files | |
| run: | | |
| pipx run --python '${{ steps.setup-python.outputs.python-path }}' tox -e docs | |
| pipx run --python '${{ steps.setup-python.outputs.python-path }}' tox -e docs-deploy -- ${{ github.event.pull_request.head.ref }} | |
| publish: | |
| needs: finalize | |
| if: ${{ github.event_name == 'push' && contains(github.ref, 'refs/tags/') }} | |
| runs-on: ubuntu-latest | |
| environment: release | |
| permissions: | |
| id-token: write | |
| contents: write | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v5 | |
| with: {python-version: "3.11"} | |
| - name: Retrieve pre-built distribution files | |
| uses: actions/download-artifact@v4 | |
| with: {name: python-distribution-files, path: dist/} | |
| - name: Publish package distributions to PyPI | |
| uses: pypa/gh-action-pypi-publish@release/v1 |