CI/CD #56
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]+' # matches to backport branches, e.g. 3.6 | |
| 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.8 | |
| - name: Cache PyPI | |
| uses: actions/cache@v3 | |
| with: | |
| key: pip-lint-${{ hashFiles('requirements/*.txt') }} | |
| path: ~/.cache/pip | |
| restore-keys: | | |
| pip-lint- | |
| - name: Install dependencies | |
| uses: py-actions/py-dependency-install@v4 | |
| with: | |
| path: requirements/lint.txt | |
| - 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: | | |
| make doc-spelling | |
| - name: Prepare twine checker | |
| run: | | |
| pip install -U twine wheel | |
| python setup.py sdist bdist_wheel | |
| env: | |
| MULTIDICT_NO_EXTENSIONS: 1 | |
| - name: Run twine checker | |
| run: | | |
| twine check dist/* | |
| test: | |
| name: Test | |
| strategy: | |
| matrix: | |
| pyver: ['3.7', '3.8', '3.9', '3.10', '3.11'] | |
| no-extensions: ['', 'Y'] | |
| os: [ubuntu, macos, windows] | |
| exclude: | |
| - os: macos | |
| no-extensions: 'Y' | |
| - os: windows | |
| no-extensions: 'Y' | |
| include: | |
| - pyver: pypy-3.8 | |
| no-extensions: 'Y' | |
| os: ubuntu | |
| fail-fast: false | |
| runs-on: ${{ matrix.os }}-latest | |
| timeout-minutes: 15 | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v3 | |
| - name: Setup Python ${{ matrix.pyver }} | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: ${{ matrix.pyver }} | |
| - name: Get pip cache dir | |
| id: pip-cache | |
| run: | | |
| echo "::set-output name=dir::$(pip cache dir)" # - name: Cache | |
| - name: Cache PyPI | |
| uses: actions/cache@v3 | |
| with: | |
| key: pip-ci-${{ runner.os }}-${{ matrix.pyver }}-{{ matrix.no-extensions }}-${{ hashFiles('requirements/*.txt') }} | |
| path: ${{ steps.pip-cache.outputs.dir }} | |
| restore-keys: | | |
| pip-ci-${{ runner.os }}-${{ matrix.pyver }}-{{ matrix.no-extensions }}- | |
| - name: Install dependencies | |
| uses: py-actions/py-dependency-install@v4 | |
| with: | |
| path: requirements/ci.txt | |
| env: | |
| MULTIDICT_NO_EXTENSIONS: ${{ matrix.no-extensions }} | |
| - name: Run unittests | |
| env: | |
| COLOR: 'yes' | |
| run: | | |
| python -m pytest tests -vv | |
| - name: Prepare coverage artifact | |
| # combining Linux and Windows paths is tricky, left this exercise for others | |
| # multidict has no Winows or MacOS specific code paths anyway | |
| if: ${{ matrix.os == 'ubuntu' }} | |
| uses: aio-libs/prepare-coverage@v22.1.2 | |
| test-summary: | |
| name: Tests status | |
| if: always() | |
| runs-on: ubuntu-latest | |
| needs: [lint, test] | |
| steps: | |
| - name: Decide whether the needed jobs succeeded or failed | |
| uses: re-actors/alls-green@release/v1 | |
| with: | |
| jobs: ${{ toJSON(needs) }} | |
| - name: Checkout | |
| uses: actions/checkout@v3 | |
| - name: Upload coverage | |
| uses: aio-libs/upload-coverage@v22.1.4 | |
| pre-deploy: | |
| name: Pre-Deploy | |
| runs-on: ubuntu-latest | |
| needs: test-summary | |
| # 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 | |
| - name: Make sdist | |
| run: | |
| python setup.py 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: Build wheels | |
| uses: pypa/cibuildwheel@v2.15.0 | |
| 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/multidict | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v3 | |
| - name: Login | |
| run: | | |
| echo "${{ secrets.GITHUB_TOKEN }}" | gh auth login --with-token | |
| - name: Download dists | |
| uses: actions/download-artifact@v3 | |
| - name: Make Release | |
| uses: aio-libs/create-release@v1.6.6 | |
| with: | |
| changes_file: CHANGES.rst | |
| name: multidict | |
| version_file: multidict/__init__.py | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| artifact: dist | |
| fix_issue_regex: ":issue:`(\\d+)`" | |
| fix_issue_repl: "(#\\1)" | |
| - name: >- | |
| Publish 🐍📦 to PyPI | |
| uses: pypa/gh-action-pypi-publish@release/v1 | |
| - name: Sign the dists with Sigstore | |
| uses: sigstore/gh-action-sigstore-python@v2.0.1 | |
| 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/** |