Add type annotation for Controller.start() (#420) #190
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]+' | |
| jobs: | |
| lint: | |
| name: Linter | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 5 | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Setup Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: 3.11 | |
| cache: 'pip' | |
| cache-dependency-path: '**/requirements*.txt' | |
| - name: Install dependencies | |
| uses: py-actions/py-dependency-install@v4 | |
| with: | |
| path: requirements-dev.txt | |
| - name: Install itself | |
| run: | | |
| pip install . | |
| - name: Mypy | |
| run: mypy | |
| - name: Flake8 | |
| run: python -m flake8 aiosmtpd setup.py housekeep.py release.py | |
| - name: Docs Checking | |
| run: | | |
| # Prepare sphinx and the deps for sphinx extensions | |
| sphinx-build --color -b doctest -d build/.doctree aiosmtpd/docs build/doctest | |
| sphinx-build --color -b html -d build/.doctree aiosmtpd/docs build/html | |
| sphinx-build --color -b man -d build/.doctree aiosmtpd/docs build/man | |
| - name: Other QA Checks | |
| shell: bash | |
| run: | | |
| # Final checks before launching the runners | |
| ver_sed='s/^__version__ = (["'"'"'])(.*)\1/\2/p;d' | |
| verfile="aiosmtpd/__init__.py" | |
| if [[ $GITHUB_REF != refs/heads/master ]]; then | |
| # Fetch master because some test cases need its existence | |
| git fetch --no-tags --prune --no-recurse-submodules --depth=1 origin master:master | |
| fi | |
| pytest -v aiosmtpd/qa | |
| check-manifest -v | |
| - name: Prepare twine checker | |
| run: | | |
| pip install -U build twine wheel | |
| python -m build | |
| - name: Run twine checker | |
| run: | | |
| twine check dist/* | |
| test: | |
| name: Test | |
| strategy: | |
| matrix: | |
| pyver: ['3.8', '3.9', '3.10', '3.11', '3.12'] | |
| os: [ubuntu, macos, windows] | |
| include: | |
| - pyver: pypy-3.8 | |
| os: ubuntu | |
| runs-on: ${{ matrix.os }}-latest | |
| timeout-minutes: 15 | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Setup Python ${{ matrix.pyver }} | |
| uses: actions/setup-python@v5 | |
| 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.txt | |
| - name: Run unittests | |
| run: pytest | |
| env: | |
| COLOR: 'yes' | |
| - run: python -m coverage xml | |
| - name: Upload coverage | |
| uses: codecov/codecov-action@v4 | |
| with: | |
| fail_ci_if_error: true | |
| token: ${{ secrets.CODECOV_TOKEN }} | |
| check: # This job does nothing and is only used for the branch protection | |
| if: always() | |
| needs: [lint, test] | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Decide whether the needed jobs succeeded or failed | |
| uses: re-actors/alls-green@release/v1 | |
| with: | |
| jobs: ${{ toJSON(needs) }} | |
| deploy: | |
| name: Deploy | |
| environment: pypi | |
| runs-on: ubuntu-latest | |
| needs: [check] | |
| if: github.event_name == 'push' && contains(github.ref, 'refs/tags/') | |
| permissions: | |
| contents: write # IMPORTANT: mandatory for making GitHub Releases | |
| id-token: write # IMPORTANT: mandatory for trusted publishing & sigstore | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Setup Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: 3.11 | |
| - name: Install dependencies | |
| run: | |
| python -m pip install -U pip wheel setuptools build twine | |
| - name: Build dists | |
| run: | | |
| python -m build | |
| - name: Make Release | |
| uses: aio-libs/create-release@v1.6.6 | |
| with: | |
| changes_file: aiosmtpd/docs/NEWS.rst | |
| name: aiosmtpd | |
| version_file: aiosmtpd/__init__.py | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| pypi_token: ${{ secrets.PYPI_API_TOKEN }} | |
| dist_dir: dist | |
| fix_issue_regex: "`#(\\d+) <https://github.com/aio-libs/aiosmtpd/issues/\\1>`" | |
| fix_issue_repl: "(#\\1)" | |
| - name: Publish 🐍📦 to PyPI | |
| uses: pypa/gh-action-pypi-publish@release/v1 |