feat: add codspeed benchmarks (#79) #287
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 | |
| pull_request: | |
| concurrency: | |
| group: ${{ github.head_ref || github.run_id }} | |
| cancel-in-progress: true | |
| jobs: | |
| lint: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v4 | |
| with: | |
| python-version: 3.x | |
| - uses: pre-commit/[email protected] | |
| # Make sure commit messages follow the conventional commits convention: | |
| # https://www.conventionalcommits.org | |
| commitlint: | |
| name: Lint Commit Messages | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - uses: wagoid/[email protected] | |
| test: | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| python-version: | |
| - "3.11" | |
| - "3.12" | |
| - "3.13-dev" | |
| os: | |
| - ubuntu-latest | |
| - macOS-latest | |
| - windows-latest | |
| extension: | |
| - "skip_cython" | |
| - "use_cython" | |
| runs-on: ${{ matrix.os }} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - uses: snok/[email protected] | |
| - name: Install Dependencies | |
| run: | | |
| if [ "${{ matrix.extension }}" = "skip_cython" ]; then | |
| SKIP_CYTHON=1 poetry install --only=main,dev | |
| else | |
| REQUIRE_CYTHON=1 poetry install --only=main,dev | |
| fi | |
| shell: bash | |
| - name: Test with Pytest | |
| run: poetry run pytest --cov-report=xml | |
| shell: bash | |
| - name: Upload coverage to Codecov | |
| uses: codecov/codecov-action@v4 | |
| with: | |
| token: ${{ secrets.CODECOV_TOKEN }} | |
| benchmark: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Setup Python 3.12 | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: 3.12 | |
| - uses: snok/[email protected] | |
| - name: Install Dependencies | |
| run: | | |
| REQUIRE_CYTHON=1 poetry install --only=main,dev | |
| shell: bash | |
| - name: Run benchmarks | |
| uses: CodSpeedHQ/action@v3 | |
| with: | |
| token: ${{ secrets.CODSPEED_TOKEN }} | |
| run: poetry run pytest --no-cov -vvvvv --codspeed | |
| release: | |
| needs: | |
| - test | |
| - lint | |
| - commitlint | |
| runs-on: ubuntu-latest | |
| environment: release | |
| concurrency: release | |
| permissions: | |
| id-token: write | |
| contents: write | |
| outputs: | |
| released: ${{ steps.release.outputs.released }} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| ref: ${{ github.head_ref || github.ref_name }} | |
| # Do a dry run of PSR | |
| - name: Test release | |
| uses: python-semantic-release/[email protected] | |
| if: github.ref_name != 'main' | |
| with: | |
| root_options: --noop | |
| # On main branch: actual PSR + upload to PyPI & GitHub | |
| - name: Release | |
| uses: bluetooth-devices/python-semantic-release@311 | |
| id: release | |
| if: github.ref_name == 'main' | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| - name: Publish package distributions to PyPI | |
| uses: pypa/gh-action-pypi-publish@release/v1 | |
| if: steps.release.outputs.released == 'true' | |
| - name: Publish package distributions to GitHub Releases | |
| uses: python-semantic-release/upload-to-gh-release@main | |
| if: steps.release.outputs.released == 'true' | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| build_wheels: | |
| needs: [release] | |
| if: needs.release.outputs.released == 'true' | |
| name: Build wheels on ${{ matrix.os }} | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| matrix: | |
| os: | |
| - macos-latest | |
| - ubuntu-latest | |
| - windows-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| with: | |
| fetch-depth: 0 | |
| ref: "main" | |
| # Used to host cibuildwheel | |
| - name: Set up Python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: "3.11" | |
| - name: Install python-semantic-release | |
| run: python3 -m pip install python-semantic-release==7.34.6 | |
| - name: Get Release Tag | |
| id: release_tag | |
| shell: bash | |
| run: | | |
| echo "::set-output name=newest_release_tag::$(semantic-release print-version --current)" | |
| - uses: actions/checkout@v3 | |
| with: | |
| ref: "v${{ steps.release_tag.outputs.newest_release_tag }}" | |
| fetch-depth: 0 | |
| - name: Install cibuildwheel | |
| run: python -m pip install cibuildwheel==2.20.0 | |
| - name: Build wheels | |
| run: python -m cibuildwheel --output-dir wheelhouse | |
| # to supply options, put them in 'env', like: | |
| env: | |
| CIBW_SKIP: cp36-* cp37-* cp38-* cp39-* cp310-* cp313-* pp36-* pp37-* pp38-* pp39-* pp310-* pp313-* | |
| CIBW_BEFORE_ALL_LINUX: apt-get install -y gcc || yum install -y gcc || apk add gcc | |
| CIBW_BUILD_VERBOSITY: 3 | |
| REQUIRE_CYTHON: 1 | |
| - uses: actions/upload-artifact@v3 | |
| with: | |
| path: ./wheelhouse/*.whl | |
| upload_pypi: | |
| needs: [build_wheels] | |
| runs-on: ubuntu-latest | |
| environment: release | |
| steps: | |
| - uses: actions/download-artifact@v3 | |
| with: | |
| # unpacks default artifact into dist/ | |
| # if `name: artifact` is omitted, the action will create extra parent dir | |
| name: artifact | |
| path: dist | |
| - uses: pypa/[email protected] | |
| with: | |
| user: __token__ | |
| password: ${{ secrets.PYPI_TOKEN }} | |
| # To test: repository_url: https://test.pypi.org/legacy/ |