CI/CD #37
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: | |
| - 'master' | |
| - '[0-9].[0-9]+' # matches to backport branches, e.g. 3.6 | |
| tags: [ 'v*' ] | |
| pull_request: | |
| branches: | |
| - 'master' | |
| - '[0-9].[0-9]+' | |
| schedule: | |
| - cron: '0 6 * * *' # Daily 6AM UTC build | |
| jobs: | |
| lint: | |
| name: Linter | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 5 | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v3 | |
| - name: Setup Python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: 3.x | |
| cache: pip | |
| cache-dependency-path: | |
| requirements/*.txt | |
| - name: Install dependencies | |
| uses: py-actions/py-dependency-install@v4 | |
| with: | |
| path: requirements/ci.txt | |
| - name: Install itself | |
| run: | | |
| pip install . | |
| env: | |
| FROZENLIST_NO_EXTENSIONS: 1 | |
| - name: Run linters | |
| run: | | |
| make lint | |
| - name: Install spell checker | |
| run: | | |
| sudo apt install libenchant-2-dev | |
| pip install -r requirements/doc.txt | |
| - name: Run docs spelling | |
| run: | | |
| towncrier build --yes --version 99.99.99 | |
| make doc-spelling | |
| - name: Prepare twine checker | |
| run: | | |
| pip install -U twine wheel | |
| python -m build | |
| env: | |
| FROZENLIST_NO_EXTENSIONS: 1 | |
| - name: Run twine checker | |
| run: | | |
| twine check --strict dist/* | |
| - name: Make sure that CONTRIBUTORS.txt remains sorted | |
| run: | | |
| LC_ALL=C sort -c CONTRIBUTORS.txt | |
| test: | |
| name: Test | |
| needs: [lint] | |
| strategy: | |
| matrix: | |
| pyver: ['3.8', '3.9', '3.10', '3.11'] | |
| no-extensions: ['', 'Y'] | |
| experimental: [false] | |
| os: [ubuntu, macos, windows] | |
| exclude: | |
| - os: macos | |
| no-extensions: 'Y' | |
| - os: windows | |
| no-extensions: 'Y' | |
| include: | |
| - pyver: 3.12-dev | |
| no-extensions: '' | |
| experimental: true | |
| os: ubuntu | |
| - pyver: 3.12-dev | |
| no-extensions: 'Y' | |
| experimental: true | |
| os: ubuntu | |
| fail-fast: false | |
| runs-on: ${{ matrix.os }}-latest | |
| timeout-minutes: 15 | |
| continue-on-error: ${{ matrix.experimental }} | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v3 | |
| - name: Setup Python ${{ matrix.pyver }} | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: ${{ matrix.pyver }} | |
| cache: pip | |
| cache-dependency-path: | |
| requirements/*.txt | |
| - name: Install dependencies | |
| uses: py-actions/py-dependency-install@v4 | |
| with: | |
| path: requirements/ci.txt | |
| - name: Cythonize | |
| if: matrix.no-extensions == '' | |
| run: | | |
| make cythonize | |
| - name: Install itself | |
| run: | | |
| pip install . | |
| env: | |
| FROZENLIST_NO_EXTENSIONS: ${{ matrix.no-extensions }} | |
| - name: Run unittests | |
| env: | |
| COLOR: 'yes' | |
| FROZENLIST_NO_EXTENSIONS: ${{ matrix.no-extensions }} | |
| run: | | |
| python -m pytest tests -vv | |
| python -m coverage xml | |
| - name: Upload coverage | |
| uses: codecov/codecov-action@v3 | |
| with: | |
| token: ${{ secrets.CODECOV_TOKEN }} | |
| file: ./coverage.xml | |
| flags: unit | |
| fail_ci_if_error: false | |
| test-summary: | |
| name: Test matrix status | |
| runs-on: ubuntu-latest | |
| needs: [test] | |
| if: always() | |
| steps: | |
| - name: Decide whether the needed jobs succeeded or failed | |
| uses: re-actors/alls-green@release/v1 | |
| with: | |
| jobs: ${{ toJSON(needs) }} | |
| pre-deploy: | |
| name: Pre-Deploy | |
| runs-on: ubuntu-latest | |
| needs: test | |
| # Run only on pushing a tag | |
| if: github.event_name == 'push' && contains(github.ref, 'refs/tags/') | |
| steps: | |
| - name: Dummy | |
| run: | | |
| echo "Predeploy step" | |
| build-tarball: | |
| name: Tarball | |
| runs-on: ubuntu-latest | |
| needs: pre-deploy | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v3 | |
| - name: Setup Python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: 3.x | |
| cache: pip | |
| cache-dependency-path: | |
| requirements/*.txt | |
| - name: Install cython | |
| uses: py-actions/py-dependency-install@v4 | |
| with: | |
| path: requirements/ci.txt | |
| - name: Cythonize | |
| run: | | |
| make cythonize | |
| - name: Make sdist | |
| run: | |
| python -m build --sdist | |
| - name: Upload artifacts | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: dist | |
| path: dist | |
| build-wheels: | |
| name: Build wheels on ${{ matrix.os }} ${{ matrix.qemu }} | |
| runs-on: ${{ matrix.os }}-latest | |
| needs: pre-deploy | |
| strategy: | |
| matrix: | |
| os: [ubuntu, windows, macos] | |
| qemu: [''] | |
| include: | |
| # Split ubuntu job for the sake of speed-up | |
| - os: ubuntu | |
| qemu: aarch64 | |
| - os: ubuntu | |
| qemu: ppc64le | |
| - os: ubuntu | |
| qemu: s390x | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v3 | |
| - name: Set up QEMU | |
| if: ${{ matrix.qemu }} | |
| uses: docker/setup-qemu-action@v2 | |
| with: | |
| platforms: all | |
| id: qemu | |
| - name: Prepare emulation | |
| run: | | |
| if [[ -n "${{ matrix.qemu }}" ]]; then | |
| # Build emulated architectures only if QEMU is set, | |
| # use default "auto" otherwise | |
| echo "CIBW_ARCHS_LINUX=${{ matrix.qemu }}" >> $GITHUB_ENV | |
| fi | |
| shell: bash | |
| - name: Setup Python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: 3.x | |
| cache: pip | |
| cache-dependency-path: | |
| requirements/*.txt | |
| - name: Install cython | |
| uses: py-actions/py-dependency-install@v4 | |
| with: | |
| path: requirements/ci.txt | |
| - name: Cythonize | |
| run: | | |
| make cythonize | |
| - name: Build wheels | |
| uses: pypa/[email protected] | |
| env: | |
| CIBW_ARCHS_MACOS: x86_64 arm64 universal2 | |
| - uses: actions/upload-artifact@v3 | |
| with: | |
| name: dist | |
| path: ./wheelhouse/*.whl | |
| deploy: | |
| name: Deploy | |
| needs: [build-tarball, build-wheels] | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: write # IMPORTANT: mandatory for making GitHub Releases | |
| id-token: write # IMPORTANT: mandatory for trusted publishing & sigstore | |
| environment: | |
| name: pypi | |
| url: https://pypi.org/p/frozenlist | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v3 | |
| - name: Download dist | |
| uses: actions/download-artifact@v3 | |
| with: | |
| name: dist | |
| path: dist | |
| - run: | | |
| tree | |
| - name: Login | |
| run: | | |
| echo "${{ secrets.GITHUB_TOKEN }}" | gh auth login --with-token | |
| - name: Make Release | |
| uses: aio-libs/[email protected] | |
| with: | |
| changes_file: CHANGES.rst | |
| name: frozenlist | |
| version_file: frozenlist/__init__.py | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| fix_issue_regex: "`#(\\d+) <https://github.com/aio-libs/frozenlist/issues/\\1>`" | |
| fix_issue_repl: "(#\\1)" | |
| - name: >- | |
| Publish 🐍📦 to PyPI | |
| uses: pypa/gh-action-pypi-publish@release/v1 | |
| - name: Sign the dists with Sigstore | |
| uses: sigstore/[email protected] | |
| with: | |
| inputs: >- | |
| ./dist/*.tar.gz | |
| ./dist/*.whl | |
| - name: Upload artifact signatures to GitHub Release | |
| # Confusingly, this action also supports updating releases, not | |
| # just creating them. This is what we want here, since we've manually | |
| # created the release above. | |
| uses: softprops/action-gh-release@v1 | |
| with: | |
| # dist/ contains the built packages, which smoketest-artifacts/ | |
| # contains the signatures and certificates. | |
| files: dist/** |