python-zeroconf · bdraco · Dec 17, 2022 · Dec 17, 2022 · Dec 17, 2022 · Dec 17, 2022
diff --git a/.coveragerc b/.coveragerc
@@ -1,5 +1,5 @@
 [report]
-exclude_lines = 
+exclude_lines =
     pragma: no cover
     if TYPE_CHECKING:
     if sys.version_info
diff --git a/.flake8 b/.flake8
@@ -0,0 +1,4 @@
+[flake8]
+exclude = docs
+max-line-length = 180
+extend-ignore = E203
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -5,66 +5,174 @@ on:
     branches:
       - master
   pull_request:
-    branches:
-      - "**"
+
+concurrency:
+  group: ${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
 
 jobs:
-  build:
-    runs-on: ${{ matrix.os }}
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v3
+        with:
+          python-version: "3.9"
+      - uses: pre-commit/action@v2.0.3
+
+  # 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@v3
+        with:
+          fetch-depth: 0
+      - uses: wagoid/commitlint-github-action@v4.1.11
+
+  test:
     strategy:
+      fail-fast: false
       matrix:
-        os: [ubuntu-latest, macos-latest, windows-latest]
-        python-version: [3.7, 3.8, 3.9, "3.10", "3.11", "pypy-3.7"]
-        include:
-          - os: ubuntu-latest
-            venvcmd: . env/bin/activate
+        python-version:
+          - "3.7"
+          - "3.8"
+          - "3.9"
+          - "3.10"
+          - "3.11"
+          - "pypy-3.7"
+        os:
+          - ubuntu-latest
+          - macos-latest
+          - windows-latest
+        extension:
+          - "skip_cython"
+          - "use_cython"
+        exclude:
           - os: macos-latest
-            venvcmd: . env/bin/activate
+            extension: use_cython
           - os: windows-latest
-            venvcmd: env\Scripts\Activate.ps1
+            extension: use_cython
+          - os: windows-latest
+            python-version: "pypy-3.7"
+    runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v2
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+      - uses: actions/checkout@v3
+      - name: Install poetry
+        run: pipx install poetry
+      - name: Set up Python
+        uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
-          architecture: 'x64'
-      - uses: actions/cache@v2
-        id: cache
+          cache: "poetry"
+      - name: Install Dependencies no cython
+        if: ${{ matrix.extension == 'skip_cython' }}
+        env:
+          SKIP_CYTHON: 1
+        run: poetry install --only=main,dev
+      - name: Install Dependencies with cython
+        if: ${{ matrix.extension != 'skip_cython' }}
+        run: poetry install --only=main,dev
+      - name: Test with Pytest
+        run: poetry run pytest --durations=20 --timeout=60 -v --cov=zeroconf --cov-branch --cov-report xml --cov-report html --cov-report term-missing tests
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v3
         with:
-          path: env
-          key: ${{ runner.os }}-pip-${{ matrix.python-version }}-${{ hashFiles('**/Makefile') }}-${{ hashFiles('**/requirements-dev.txt') }}
-          restore-keys: |
-            ${{ runner.os }}-pip-${{ matrix.python-version }}-${{ hashFiles('**/Makefile') }}
-      - name: Install dependencies
-        if: steps.cache.outputs.cache-hit != 'true'
-        run: |
-          python -m venv env
-          ${{ matrix.venvcmd }}
-          pip install --upgrade -r requirements-dev.txt pytest-github-actions-annotate-failures
-      - name: Validate readme
-        if: ${{ runner.os == 'Linux' && matrix.python-version != 'pypy-3.7' }}
-        run: |
-          ${{ matrix.venvcmd }}
-          python -m readme_renderer README.rst -o -
-      - name: Run flake8
-        if: ${{ runner.os == 'Linux' && matrix.python-version != 'pypy-3.7' }}
-        run: |
-          ${{ matrix.venvcmd }}
-          make flake8
-      - name: Run mypy
-        if: ${{ runner.os == 'Linux' && matrix.python-version != 'pypy-3.7' }}
-        run: |
-          ${{ matrix.venvcmd }}
-          make mypy
-      - name: Run black_check
-        if: ${{ runner.os == 'Linux' && matrix.python-version != 'pypy-3.7' }}
-        run: |
-          ${{ matrix.venvcmd }}
-          make black_check
-      - name: Run tests
+          token: ${{ secrets.CODECOV_TOKEN }}
+
+  release:
+    runs-on: ubuntu-latest
+    environment: release
+    if: github.ref == 'refs/heads/master'
+    needs:
+      - test
+      - lint
+      - commitlint
+
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      # Run semantic release:
+      # - Update CHANGELOG.md
+      # - Update version in code
+      # - Create git tag
+      # - Create GitHub release
+      # - Publish to PyPI
+      - name: Python Semantic Release
+        uses: relekang/python-semantic-release@v7.32.2
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          pypi_token: ${{ secrets.PYPI_TOKEN }}
+
+  build_wheels:
+    needs: [release]
+
+    name: Build wheels on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-20.04, windows-2019, macOS-11]
+
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+          ref: "master"
+
+      # Used to host cibuildwheel
+      - name: Set up Python
+        uses: actions/setup-python@v4
+
+      - name: Install python-semantic-release
+        run: python -m pip install python-semantic-release
+
+      - name: Get Release Tag
+        id: release_tag
+        shell: bash
         run: |
-          ${{ matrix.venvcmd }}
-          make test_coverage
-      - name: Report coverage to Codecov
-        uses: codecov/codecov-action@v1
+          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.11.3
+
+      - name: Build wheels
+        run: python -m cibuildwheel --output-dir wheelhouse
+        # to supply options, put them in 'env', like:
+        env:
+          CIBW_SKIP: cp36-*
+          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/gh-action-pypi-publish@v1.5.0
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_TOKEN }}
+          repository_url: https://test.pypi.org/legacy/
+
+          # To test: repository_url: https://test.pypi.org/legacy/
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,61 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+exclude: "CHANGELOG.md"
+default_stages: [commit]
+
+ci:
+  autofix_commit_msg: "chore(pre-commit.ci): auto fixes"
+  autoupdate_commit_msg: "chore(pre-commit.ci): pre-commit autoupdate"
+
+repos:
+  - repo: https://github.com/commitizen-tools/commitizen
+    rev: v2.32.4
+    hooks:
+      - id: commitizen
+        stages: [commit-msg]
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.3.0
+    hooks:
+      - id: debug-statements
+      - id: check-builtin-literals
+      - id: check-case-conflict
+      - id: check-docstring-first
+      - id: check-json
+      - id: check-toml
+      - id: check-xml
+      - id: check-yaml
+      - id: detect-private-key
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+      - id: debug-statements
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: v2.7.1
+    hooks:
+      - id: prettier
+        args: ["--tab-width", "2"]
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v2.37.3
+    hooks:
+      - id: pyupgrade
+        args: [--py37-plus]
+  - repo: https://github.com/PyCQA/isort
+    rev: 5.10.1
+    hooks:
+      - id: isort
+  - repo: https://github.com/psf/black
+    rev: 22.8.0
+    hooks:
+      - id: black
+  #  - repo: https://github.com/codespell-project/codespell
+  #    rev: v2.2.1
+  #    hooks:
+  #      - id: codespell
+  - repo: https://github.com/PyCQA/flake8
+    rev: 5.0.4
+    hooks:
+      - id: flake8
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v0.931
+    hooks:
+      - id: mypy
+        additional_dependencies: []