chore(dev): revise CI

corresponding to nRF24/.github#23

Author: 2bndy5

.github/dependabot.yml

@@ -10,4 +10,10 @@ updates:
     # default location of `.github/workflows`
     directory: "/"
     schedule:
-      interval: "weekly"
+      interval: "monthly"
+    cooldown:
+      default-days: 5
+    groups:
+      actions:
+        patterns:
+          - "*"

.github/doxygen.py

@@ -4,6 +4,7 @@
 Running this locally will alter the Doxyfile.
 Such changes SHOULD NOT be pushed to the remote.
 """
+
 from pathlib import Path
 import json
 
@@ -17,9 +18,12 @@ def overwrite_doxygen_value():
     properties = json.loads(PROPERTIES.read_text(encoding="utf-8"))
     assert "version" in properties
     config = CONFIG.read_text(encoding="utf-8")
-    TMP.write_text("PROJECT_NUMBER = {}\n".format(properties["version"]), encoding="utf-8")
+    TMP.write_text(
+        "PROJECT_NUMBER = {}\n".format(properties["version"]), encoding="utf-8"
+    )
     config += f"\n@INCLUDE = {str(TMP)}\n"
     CONFIG.write_text(config, encoding="utf-8")
 
+
 if __name__ == "__main__":
     overwrite_doxygen_value()

.github/workflows/build_arduino.yml

@@ -15,6 +15,8 @@ on:
       - "examples/**"
       - "!examples/old_backups/**"
 
+permissions: {}
+
 jobs:
   build:
     uses: nRF24/.github/.github/workflows/build_arduino.yaml@main
@@ -160,4 +162,7 @@ jobs:
   report:
     needs: [build] # , attiny]
     if: github.event_name == 'pull_request'
+    permissions:
+      # for posting/updating comments on PR threads
+      pull-requests: write
     uses: nRF24/.github/.github/workflows/arduino_size_deltas.yaml@main

.github/workflows/build_linux.yml

@@ -25,6 +25,7 @@ on:
       - ".github/workflows/build_linux.yml"
   push:
     branches: [master]
+    tags: ["*"]
     paths:
       - "*.h"
       - "*.cpp"
@@ -45,13 +46,13 @@ on:
       - "pyRF24/setup.py"
       - "pyRF24/pyRF24.cpp"
       - ".github/workflows/build_linux.yml"
-  release:
-    types: [created]
 
 env:
   # Customize the CMake build type here (Release, Debug, RelWithDebInfo, etc.)
   BUILD_TYPE: Release
 
+permissions: {}
+
 jobs:
 
   ####################### using Makefile #############################
@@ -100,6 +101,11 @@ jobs:
 
       - name: provide pigpio
         if: ${{ matrix.config-options == '--driver=pigpio' }}
+        env:
+          # this env var is supported as of CMake v3.29+
+          CMAKE_INSTALL_PREFIX: /usr/arm-linux-gnueabihf
+          # this env var is supported as of CMake v3.21+
+          CMAKE_TOOLCHAIN_FILE: ${{ github.workspace }}/cmake/toolchains/armhf.cmake
         run: |
           git clone https://github.com/joan2937/pigpio.git
           cd pigpio
@@ -108,8 +114,7 @@ jobs:
           git checkout $latestTag
           mkdir build
           cd build
-          cmake .. -D CMAKE_INSTALL_PREFIX=/usr/arm-linux-gnueabihf \
-          -D CMAKE_TOOLCHAIN_FILE=${{ github.workspace }}/cmake/toolchains/armhf.cmake
+          cmake ..
           make
           sudo make install
         
@@ -118,22 +123,26 @@ jobs:
         env:
           CC: /usr/bin/arm-linux-gnueabihf-gcc
           CXX: /usr/bin/arm-linux-gnueabihf-g++
+          # this env var is supported as of CMake v3.29+
+          CMAKE_INSTALL_PREFIX: /usr/arm-linux-gnueabihf
+          # this env var is supported as of CMake v3.21+
+          CMAKE_TOOLCHAIN_FILE: ${{ github.workspace }}/cmake/toolchains/armhf.cmake
         run: |
           git clone https://github.com/intel-iot-devkit/mraa.git
           cd mraa
           mkdir build
           cd build
           cmake .. \
           -D BUILDSWIGNODE=OFF \
-          -D BUILDARCH=arm \
-          -D CMAKE_INSTALL_PREFIX=/usr/arm-linux-gnueabihf \
-          -D CMAKE_TOOLCHAIN_FILE=${{ github.workspace }}/cmake/toolchains/armhf.cmake
+          -D BUILDARCH=arm
           sudo make install
           sudo bash -c 'echo "/usr/local/lib/arm-linux-gnueabihf" >> /etc/ld.so.conf'
           sudo ldconfig
 
       - name: library configure
-        run: ./configure ${{ matrix.config-options }}
+        env:
+          CONFIG_OPTIONS: ${{ matrix.config-options }}
+        run: ./configure ${CONFIG_OPTIONS}
 
       - name: library make
         run: make
@@ -150,14 +159,13 @@ jobs:
 
   ####################### using CMake ################################
   using_cmake:
-    uses: nRF24/.github/.github/workflows/build_linux_cmake.yaml@main
+    uses: nRF24/.github/.github/workflows/build_linux_cmake.yaml@review-ci
     with:
       rf24-ref: ${{ github.sha }}
       driver: ${{ matrix.driver }}
       compiler: ${{ matrix.toolchain.compiler }}
       usr-dir: ${{ matrix.toolchain.usr_dir }}
       examples-path: examples_linux
-      deploy-release: ${{ github.event_name == 'release' && (matrix.toolchain.compiler == 'armhf' || matrix.toolchain.compiler == 'arm64') && (matrix.driver =='RPi' || matrix.driver =='SPIDEV') }}
       py-wrapper-path: pyRF24
     strategy:
       fail-fast: false
@@ -195,3 +203,11 @@ jobs:
             toolchain:
               compiler: "default" # github runner is hosted on a "amd64"
               usr_dir: "local"
+
+  deploy-release-assets:
+    needs: [using_cmake]
+    permissions:
+      # needed for uploading release assets
+      contents: write
+    if: startsWith(github.ref, 'refs/tags/')
+    uses: nRF24/.github/.github/workflows/deploy_cpack_artifacts.yaml@review-ci

.github/workflows/build_platformIO.yml

@@ -17,15 +17,11 @@ on:
       - "examples/**"
       - "!examples/old_backups/**"
       - "!examples/rf24_ATTiny/**"
-  release:
-    types: [created]
+    tags: ["*"]
 
 jobs:
   validate_lib_json:
-    uses: nRF24/.github/.github/workflows/validate_deploy_platformio.yaml@main
-    secrets: inherit
-    with:
-      deploy-release: ${{ github.event_name == 'release' }}
+    uses: nRF24/.github/.github/workflows/vaildate_platformio.yaml@review-ci
 
   build:
     needs: [validate_lib_json]
@@ -55,3 +51,12 @@ jobs:
           - "blackpill_f103c8"
           - "nodemcuv2"
           - "adafruit_qtpy_esp32s2"
+
+  deploy-pio-assets:
+    if: startsWith(github.ref, 'refs/tags/')
+    needs: [validate_lib_json, build]
+    permissions:
+      # needed for uploading release assets
+      contents: write
+    uses: nRF24/.github/.github/workflows/deploy_platformio_artifact.yaml@review-ci
+    secrets: inherit

.github/workflows/build_rp2xxx.yml

@@ -24,9 +24,11 @@ on:
       - "utility/rp2/*"
       - "examples_pico/*"
 
+permissions: {}
+
 jobs:
   build:
-    uses: nRF24/.github/.github/workflows/build_pico_sdk.yaml@main
+    uses: nRF24/.github/.github/workflows/build_pico_sdk.yaml@review-ci
     with:
       board-id: ${{ matrix.board }}
       rf24-ref: ${{ github.sha }}

.github/workflows/clang_format.yml

@@ -7,8 +7,11 @@ on:
         branches: [master]
 
 jobs:
-    check_formatting:
-        uses: nRF24/.github/.github/workflows/cpp_lint.yaml@main
-        with:
-          ignore: examples/old_backups|utility/RPi/bcm2835.h|utility/RPi/bcm2835.c
-          extensions: ino,c,cpp,h
+  check_formatting:
+    permissions:
+      # needed to post review suggestions on a PR
+      pull-requests: write
+    uses: nRF24/.github/.github/workflows/cpp_lint.yaml@review-ci
+    with:
+      ignore: examples/old_backups|utility/RPi/bcm2835.h|utility/RPi/bcm2835.c
+      extensions: ino,c,cpp,h

.github/workflows/doxygen.yml

@@ -31,8 +31,7 @@ on:
       - ".github/workflows/doxygen.yml"
       - "Doxyfile"
       - "library.properties" # get lib version from here
-  release:
-    types: [published, edited]
+    tags: ["*"]
   workflow_dispatch:
 
 jobs:
@@ -49,8 +48,15 @@ jobs:
         run: npm install -g cspell
       - run: npx cspell --gitignore --config cspell.config.yaml .
   build-docs:
-    uses: nRF24/.github/.github/workflows/build_docs.yaml@main
+    uses: nRF24/.github/.github/workflows/build_docs.yaml@review-ci
     with:
-      deploy-gh-pages: ${{ github.event_name == 'release' || (github.event_name == 'workflow_dispatch' && github.ref == 'refs/heads/master') }}
       doxygen-version: '1.13.2'
     secrets: inherit
+
+  deploy-docs:
+    needs: [build-docs]
+    if: github.ref == 'refs/heads/master' || startsWith(github.ref, 'refs/tags/')
+    permissions:
+      id-token: write
+    uses: nRF24/.github/.github/workflows/deploy_docs.yaml@review-ci
+    secrets: inherit