Merge pull request #2 from david-cermak/feat/ci_extend_publish

Improve CI and pre-commit checks

.flake8

@@ -0,0 +1,137 @@
+[flake8]
+
+select =
+    # Full lists are given in order to suppress all errors from other plugins
+    # Full list of pyflakes error codes:
+    F401,           # module imported but unused
+    F402,           # import module from line N shadowed by loop variable
+    F403,           # 'from module import *' used; unable to detect undefined names
+    F404,           # future import(s) name after other statements
+    F405,           # name may be undefined, or defined from star imports: module
+    F406,           # 'from module import *' only allowed at module level
+    F407,           # an undefined __future__ feature name was imported
+    F601,           # dictionary key name repeated with different values
+    F602,           # dictionary key variable name repeated with different values
+    F621,           # too many expressions in an assignment with star-unpacking
+    F622,           # two or more starred expressions in an assignment (a, *b, *c = d)
+    F631,           # assertion test is a tuple, which are always True
+    F701,           # a break statement outside of a while or for loop
+    F702,           # a continue statement outside of a while or for loop
+    F703,           # a continue statement in a finally block in a loop
+    F704,           # a yield or yield from statement outside of a function
+    F705,           # a return statement with arguments inside a generator
+    F706,           # a return statement outside of a function/method
+    F707,           # an except: block as not the last exception handler
+    F721, F722,     #    doctest syntax error syntax error in forward type annotation
+    F811,           # redefinition of unused name from line N
+    F812,           # list comprehension redefines name from line N
+    F821,           # undefined name name
+    F822,           # undefined name name in __all__
+    F823,           # local variable name referenced before assignment
+    F831,           # duplicate argument name in function definition
+    F841,           # local variable name is assigned to but never used
+    F901,           # raise NotImplemented should be raise NotImplementedError
+
+    # Full list of pycodestyle violations:
+    E101,           # indentation contains mixed spaces and tabs
+    E111,           # indentation is not a multiple of four
+    E112,           # expected an indented block
+    E113,           # unexpected indentation
+    E114,           # indentation is not a multiple of four (comment)
+    E115,           # expected an indented block (comment)
+    E116,           # unexpected indentation (comment)
+    E121,           # continuation line under-indented for hanging indent
+    E122,           # continuation line missing indentation or outdented
+    E123,           # closing bracket does not match indentation of opening bracket's line
+    E124,           # closing bracket does not match visual indentation
+    E125,           # continuation line with same indent as next logical line
+    E126,           # continuation line over-indented for hanging indent
+    E127,           # continuation line over-indented for visual indent
+    E128,           # continuation line under-indented for visual indent
+    E129,           # visually indented line with same indent as next logical line
+    E131,           # continuation line unaligned for hanging indent
+    E133,           # closing bracket is missing indentation
+    E201,           # whitespace after '('
+    E202,           # whitespace before ')'
+    E203,           # whitespace before ':'
+    E211,           # whitespace before '('
+    E221,           # multiple spaces before operator
+    E222,           # multiple spaces after operator
+    E223,           # tab before operator
+    E224,           # tab after operator
+    E225,           # missing whitespace around operator
+    E226,           # missing whitespace around arithmetic operator
+    E227,           # missing whitespace around bitwise or shift operator
+    E228,           # missing whitespace around modulo operator
+    E231,           # missing whitespace after ',', ';', or ':'
+    E241,           # multiple spaces after ','
+    E242,           # tab after ','
+    E251,           # unexpected spaces around keyword / parameter equals
+    E261,           # at least two spaces before inline comment
+    E262,           # inline comment should start with '# '
+    E265,           # block comment should start with '# '
+    E266,           # too many leading '#' for block comment
+    E271,           # multiple spaces after keyword
+    E272,           # multiple spaces before keyword
+    E273,           # tab after keyword
+    E274,           # tab before keyword
+    E275,           # missing whitespace after keyword
+    E301,           # expected 1 blank line, found 0
+    E302,           # expected 2 blank lines, found 0
+    E303,           # too many blank lines
+    E304,           # blank lines found after function decorator
+    E305,           # expected 2 blank lines after end of function or class
+    E306,           # expected 1 blank line before a nested definition
+    E401,           # multiple imports on one line
+    E402,           # module level import not at top of file
+    E501,           # line too long (82 > 79 characters)
+    E502,           # the backslash is redundant between brackets
+    E701,           # multiple statements on one line (colon)
+    E702,           # multiple statements on one line (semicolon)
+    E703,           # statement ends with a semicolon
+    E704,           # multiple statements on one line (def)
+    E711,           # comparison to None should be 'if cond is None:'
+    E712,           # comparison to True should be 'if cond is True:' or 'if cond:'
+    E713,           # test for membership should be 'not in'
+    E714,           # test for object identity should be 'is not'
+    E721,           # do not compare types, use 'isinstance()'
+    E722,           # do not use bare except, specify exception instead
+    E731,           # do not assign a lambda expression, use a def
+    E741,           # do not use variables named 'l', 'O', or 'I'
+    E742,           # do not define classes named 'l', 'O', or 'I'
+    E743,           # do not define functions named 'l', 'O', or 'I'
+    E901,           # SyntaxError or IndentationError
+    E902,           # IOError
+    W191,           # indentation contains tabs
+    W291,           # trailing whitespace
+    W292,           # no newline at end of file
+    W293,           # blank line contains whitespace
+    W391,           # blank line at end of file
+    W503,           # line break before binary operator
+    W504,           # line break after binary operator
+    W505,           # doc line too long (82 > 79 characters)
+    W601,           # .has_key() is deprecated, use 'in'
+    W602,           # deprecated form of raising exception
+    W603,           # '<>' is deprecated, use '!='
+    W604,           # backticks are deprecated, use 'repr()'
+    W605,           # invalid escape sequence 'x'
+    W606,           # 'async' and 'await' are reserved keywords starting with Python 3.7
+
+    # Full list of flake8 violations
+    E999,           # failed to compile a file into an Abstract Syntax Tree for the plugins that require it
+
+    # Full list of mccabe violations
+    C901            # complexity value provided by the user
+
+ignore =
+    E221,           # multiple spaces before operator
+    E231,           # missing whitespace after ',', ';', or ':'
+    E241,           # multiple spaces after ','
+    W503,           # line break before binary operator
+    W504            # line break after binary operator
+
+max-line-length = 160
+
+show_source = True
+
+statistics = True

.github/workflows/build.yml

@@ -1,4 +1,4 @@
-name: "esp_wifi_remote: build-tests"
+name: "Build"
 
 on:
   push:
@@ -8,25 +8,6 @@ on:
     types: [opened, synchronize, reopened, labeled]
 
 jobs:
-  wifi_remote_api_compat:
-    name: Check API compatibility of WiFi Remote
-    strategy:
-      matrix:
-        idf_ver: ["latest", "release-v5.3"]
-    runs-on: ubuntu-20.04
-    container: espressif/idf:${{ matrix.idf_ver }}
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v3
-      - name: Check that headers are the same as generated
-        shell: bash
-        run: |
-          . ${IDF_PATH}/export.sh
-          pip install idf-component-manager idf-build-apps --upgrade
-          cp -r ./components/esp_wifi_remote ./components/esp_wifi_remote_base
-          cd ./components/esp_wifi_remote/scripts
-          python generate_and_check.py --base-dir ../../esp_wifi_remote_base
-
   build_wifi_remote:
     name: Build WiFi Remote Test
     strategy:
@@ -94,35 +75,3 @@ jobs:
           . ${IDF_PATH}/export.sh
           pip install idf-component-manager idf-build-apps --upgrade
           python $GITHUB_WORKSPACE/protocols/ci/build_apps.py ./components/esp_wifi_remote/${{matrix.example.path}} -vv --preserve-all
-
-  build_idf_examples_with_wifi_remote:
-    name: Build IDF examples with WiFi Remote
-    strategy:
-      matrix:
-        idf_ver: ["latest", "release-v5.3"]
-        idf_target: ["esp32p4", "esp32h2", "esp32s3"]
-        test: [ { app: idf_mqtt_example, path: "examples/protocols/mqtt/tcp" }]
-    runs-on: ubuntu-20.04
-    container: espressif/idf:${{ matrix.idf_ver }}
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v3
-      - name: ccache
-        uses: hendrikmuhs/[email protected]
-        with:
-            key: ${{ matrix.idf_ver }}
-      - name: Build ${{ matrix.test.app }} with IDF-${{ matrix.idf_ver }} for ${{ matrix.idf_target }}
-        shell: bash
-        run: |
-          . ${IDF_PATH}/export.sh
-          pip install idf-component-manager idf-build-apps --upgrade
-          export OVERRIDE_PATH=`pwd`/components/esp_wifi_remote
-          echo ${OVERRIDE_PATH}
-          sed -i '/espressif\/esp_wifi_remote:/a \ \ \ \ override_path: "${OVERRIDE_PATH}"' ${IDF_PATH}/${{matrix.test.path}}/main/idf_component.yml
-          cat ${IDF_PATH}/${{matrix.test.path}}/main/idf_component.yml
-          export PEDANTIC_FLAGS="-DIDF_CI_BUILD -Werror -Werror=deprecated-declarations -Werror=unused-variable -Werror=unused-but-set-variable -Werror=unused-function"
-          export EXTRA_CFLAGS="${PEDANTIC_FLAGS} -Wstrict-prototypes"
-          export EXTRA_CXXFLAGS="${PEDANTIC_FLAGS}"
-          cd ${IDF_PATH}/${{matrix.test.path}}
-          idf-build-apps find --config sdkconfig.ci* -vv --target ${{ matrix.idf_target }}
-          idf-build-apps build --config sdkconfig.ci* -vv --target ${{ matrix.idf_target }}

.github/workflows/pre_commit_check.yml

@@ -0,0 +1,45 @@
+name: Check pre-commit rules
+
+on:
+  pull_request:
+    types: [opened, reopened, synchronize]
+
+permissions:
+  contents: read
+
+jobs:
+  pre_commit_check:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.base_ref }}
+          fetch-depth: 20
+      - name: Fetch head and base refs
+        # This is necessary for pre-commit to check the changes in the PR branch (and to set origin/HEAD and HEAD refs)
+        run: |
+          git fetch origin ${{ github.event.pull_request.head.sha }}:pr_ref
+          git checkout pr_ref
+          git remote set-head origin --auto
+          git merge-base origin/HEAD HEAD || ( echo "Your PR is far behind origin/HEAD, please rebase" && exit 1 )
+      - name: Set up Python environment
+        uses: actions/setup-python@master
+        with:
+          python-version: v3.8
+      - name: Install python packages
+        run: |
+          pip install pre-commit
+          pre-commit install-hooks
+      - name: Run pre-commit and check for any changes
+        run: |
+          echo "Commits being checked:"
+          git log --oneline --no-decorate origin/HEAD..HEAD
+          echo ""
+          if ! pre-commit run --from-ref origin/HEAD --to-ref HEAD --hook-stage manual --show-diff-on-failure ; then
+            echo ""
+            echo "::notice::It looks like the commits in this PR have been made without having pre-commit hooks installed."
+            echo "::notice::Please see https://github.com/espressif/esp-wifi-remote/CONTRIBUTING.md for instructions."
+            echo ""
+            exit 1
+          fi

.github/workflows/publish.yml

@@ -0,0 +1,58 @@
+name: Publish esp-wifi-remote
+
+on:
+  workflow_run:
+    workflows: ["Build", "Compat checks"]
+    branches: [main]
+    types:
+      - completed
+
+jobs:
+  publish:
+    if: ${{ github.event.workflow_run.conclusion == 'success' }}
+    name: Publishes Tag, Release, and Uploads Component
+
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+          fetch-depth: 0
+          token: "${{ secrets.GITHUB_TOKEN }}"
+      - name: Checkout protocols
+        uses: actions/checkout@v4
+        with:
+          repository: espressif/esp-protocols
+          ref: wifi_remote-v0.4.0
+          sparse-checkout: |
+            ci/detect_component_bump
+          sparse-checkout-cone-mode: false
+          path: protocols
+
+      - name: Check for version update
+        shell: bash
+        run: $GITHUB_WORKSPACE/protocols/ci/detect_component_bump
+
+      - name: Tag merge commit
+        if: env.BUMP_VERSION != ''
+        uses: anothrNick/[email protected]
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          CUSTOM_TAG: ${{ env.BUMP_TAG }}
+
+      - name: Create Release
+        if: env.BUMP_VERSION != ''
+        uses: softprops/action-gh-release@v1
+        with:
+          body_path: "release_notes.md"
+          tag_name: ${{ env.BUMP_TAG }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Upload esp_wifi_remote to IDF Component Registry
+        uses: espressif/upload-components-ci-action@v1
+        with:
+          directories: >
+            components/esp_wifi_remote;
+          namespace: "espressif"
+          api_token: ${{ secrets.IDF_COMPONENT_API_TOKEN }}

.github/workflows/smoke_compat.yml

@@ -0,0 +1,62 @@
+name: "Compat checks"
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    types: [opened, synchronize, reopened, labeled]
+  schedule:
+    - cron: '0 0 * * *' # Once per day at midnight
+
+jobs:
+  wifi_remote_api_compat:
+    name: Check API compatibility of WiFi Remote
+    strategy:
+      matrix:
+        idf_ver: ["latest", "release-v5.3"]
+    runs-on: ubuntu-20.04
+    container: espressif/idf:${{ matrix.idf_ver }}
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - name: Check that headers are the same as generated
+        shell: bash
+        run: |
+          . ${IDF_PATH}/export.sh
+          pip install idf-component-manager idf-build-apps --upgrade
+          cp -r ./components/esp_wifi_remote ./components/esp_wifi_remote_base
+          cd ./components/esp_wifi_remote/scripts
+          python generate_and_check.py --base-dir ../../esp_wifi_remote_base
+
+  build_idf_examples_with_wifi_remote:
+    name: Build IDF examples with WiFi Remote
+    strategy:
+      matrix:
+        idf_ver: ["latest", "release-v5.3"]
+        idf_target: ["esp32p4", "esp32h2", "esp32s3"]
+        test: [ { app: idf_mqtt_example, path: "examples/protocols/mqtt/tcp" }]
+    runs-on: ubuntu-20.04
+    container: espressif/idf:${{ matrix.idf_ver }}
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - name: ccache
+        uses: hendrikmuhs/[email protected]
+        with:
+            key: ${{ matrix.idf_ver }}
+      - name: Build ${{ matrix.test.app }} with IDF-${{ matrix.idf_ver }} for ${{ matrix.idf_target }}
+        shell: bash
+        run: |
+          . ${IDF_PATH}/export.sh
+          pip install idf-component-manager idf-build-apps --upgrade
+          export OVERRIDE_PATH=`pwd`/components/esp_wifi_remote
+          echo ${OVERRIDE_PATH}
+          sed -i '/espressif\/esp_wifi_remote:/a \ \ \ \ override_path: "${OVERRIDE_PATH}"' ${IDF_PATH}/${{matrix.test.path}}/main/idf_component.yml
+          cat ${IDF_PATH}/${{matrix.test.path}}/main/idf_component.yml
+          export PEDANTIC_FLAGS="-DIDF_CI_BUILD -Werror -Werror=deprecated-declarations -Werror=unused-variable -Werror=unused-but-set-variable -Werror=unused-function"
+          export EXTRA_CFLAGS="${PEDANTIC_FLAGS} -Wstrict-prototypes"
+          export EXTRA_CXXFLAGS="${PEDANTIC_FLAGS}"
+          cd ${IDF_PATH}/${{matrix.test.path}}
+          idf-build-apps find --config sdkconfig.ci* -vv --target ${{ matrix.idf_target }}
+          idf-build-apps build --config sdkconfig.ci* -vv --target ${{ matrix.idf_target }}