Tpwrules wip

.github/dependabot.yml

@@ -3,7 +3,7 @@ updates:
   - package-ecosystem: 'github-actions'
     directory: '/'
     schedule:
-      interval: 'daily'
+      interval: 'weekly'
     labels:
       - 'CI/CD'
     commit-message:

.github/workflows/build_documentation.yaml

@@ -1,13 +1,19 @@
-name: Check for Complete Documentation
+name: Check, Build, and Publish Documentation
 
 on:
   # Triggers the workflow on push or pull request events
   push:
   pull_request:
   # Trigger when a release is created
+  # NOTE: This will only trigger if the release is created from the UI or with a personal access token
   release:
     types:
       - published
+  # Trigger with the release workflow finishes
+  workflow_run:
+    workflows: ['Create a New Release']
+    types: [completed]
+    branches: [master]
   # Also give a manual trigger
   workflow_dispatch:
     inputs:
@@ -21,18 +27,10 @@ concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: true
 
-env:
-  REBUILD_CACHE_NUMBER: 2
-  PYTHON_DEPS_ARCHIVE_NUM: 2
-  DOXYGEN_VERSION: Release_1_9_6
-  TEX_VERSION: 2019
-  # ^^ 2019 is the latest TeX live available on apt-get and that's good enough
-  GRAPHVIZ_VERSION: 2.43.0
-
 jobs:
   check_menu_inclusion:
     runs-on: ubuntu-latest
-    if: "!contains(github.event.head_commit.message, 'ci skip')"
+    if: ${{ ! contains(github.event.head_commit.message, 'ci skip') }}
     name: Check that all classes are documented in the menu-a-la-carte example
 
     steps:
@@ -78,78 +76,11 @@ jobs:
         run: exit 1
 
   doc_build:
-    runs-on: ubuntu-latest
-    if: "!contains(github.event.head_commit.message, 'ci skip')"
+    if: ${{ (! contains(github.event.head_commit.message, 'ci skip')) && (github.event_name != 'workflow_run' || (github.event_name == 'workflow_run' && github.event.workflow_run.conclusion == 'success')) }}
     name: Build documentation
-
-    steps:
-      # check out the ModularSensors repo
-      - uses: actions/checkout@v4
-        with:
-          path: code_docs/ModularSensors
-
-      - name: Set up Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: '3.x'
-
-      - name: Restore Python Dependencies
-        uses: actions/cache@v4
-        id: cache_python
-        with:
-          path: ~/.cache/pip
-          key: ${{ runner.os }}-python-${{ env.REBUILD_CACHE_NUMBER }}-${{ env.PYTHON_DEPS_ARCHIVE_NUM }}
-
-      - name: Install Pygments and other m.css Python Requirements
-        run: |
-          python -m pip install --upgrade pip
-          pip3 install --upgrade --upgrade-strategy only-if-needed jinja2 Pygments beautifulsoup4
-
-      - name: Restore Doxygen, Graphviz, and TeX Live
-        id: cache_doxygen
-        uses: actions/cache@v4
-        with:
-          path: |
-            /usr/lib/x86_64-linux-gnu/texlive
-            /usr/lib/x86_64-linux-gnu/graphviz
-            doxygen-src
-          key: ${{ runner.os }}-doxygen-${{ env.REBUILD_CACHE_NUMBER }}-${{ env.DOXYGEN_VERSION }}-${{ env.TEX_VERSION }}-${{ env.GRAPHVIZ_VERSION }}
-
-      - name: Build and install doxygen and its dependencies
-        if: steps.cache_doxygen.outputs.cache-hit != 'true'
-        run: |
-          cd ${{ github.workspace }}/code_docs/ModularSensors/
-          chmod +x continuous_integration/build-install-doxygen.sh
-          sh continuous_integration/build-install-doxygen.sh
-
-      # check out my fork of m.css, for processing Doxygen output
-      - name: Checkout m.css
-        uses: actions/checkout@v4
-        with:
-          # Repository name with owner. For example, actions/checkout
-          repository: SRGDamia1/m.css
-          path: code_docs/m.css
-
-      - name: Generate all the documentation
-        continue-on-error: true
-        run: |
-          cd ${{ github.workspace }}/code_docs/ModularSensors/
-          chmod +x continuous_integration/generate-documentation.sh
-          sh continuous_integration/generate-documentation.sh 2>&1 | tee doxygen_run_output.log
-          result_code=${PIPESTATUS[0]}
-          echo "doxygen_warnings=$(cat docs/output_doxygen.log)" >> $GITHUB_OUTPUT
-          echo "mcss_warnings=$(cat docs/output_mcss.log)" >> $GITHUB_OUTPUT
-          echo "## Doxygen completed with the following warnings:" >> $GITHUB_STEP_SUMMARY
-          echo "$(cat docs/output_doxygen.log)" >> $GITHUB_STEP_SUMMARY
-          echo "" >> $GITHUB_STEP_SUMMARY
-          echo "## mcss Doxygen post-processing completed with the following warnings:" >> $GITHUB_STEP_SUMMARY
-          echo "$(cat docs/output_mcss.log)" >> $GITHUB_STEP_SUMMARY
-          echo "Finished generating documentation"
-          exit $result_code
-
-      - name: Deploy to github pages
-        if: "(github.event_name == 'release' && github.event.action == 'published') || (github.event_name == 'workflow_dispatch' && github.event.inputs.publish == 'true')"
-        uses: peaceiris/[email protected]
-        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: ${{ github.workspace }}/code_docs/ModularSensorsDoxygen/m.css
+    uses: EnviroDIY/workflows/.github/workflows/build_documentation.yaml@main
+    with:
+      use_graphviz: false
+      publish: ${{ (github.event_name == 'release' && github.event.action == 'published') || (github.event_name == 'workflow_run' && github.event.workflow_run.conclusion == 'success')  || (github.event_name == 'workflow_dispatch' && github.event.inputs.publish == 'true')}}
+      rebuild_cache_number: 1
+    secrets: inherit

.github/workflows/build_examples.yaml

@@ -8,233 +8,10 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
-  generate_matrix:
-    name: Generate build matrices
-    runs-on: ubuntu-latest
-    if: "!contains(github.event.head_commit.message, 'ci skip')"
-    outputs:
-      arduino_job_matrix: ${{ steps.py_matrix.outputs.arduino_job_matrix }}
-      pio_job_matrix: ${{ steps.py_matrix.outputs.pio_job_matrix }}
-
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Set up Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: '3.x'
-          cache: 'pip'
-
-      - name: Install python dependencies, including PlatformIO
-        run: pip install -r continuous_integration/requirements.txt
-
-      - name: Generate Matrices
-        id: py_matrix
-        run: |
-          python continuous_integration/generate_job_matrix.py
-
-      - name: Store generated examples
-        uses: actions/upload-artifact@v4
-        with:
-          name: generated_examples
-          path: |
-            continuous_integration_artifacts/
-
-  print_job_matrix:
-    name: print_job_matrix
-    runs-on: ubuntu-latest
-    needs: generate_matrix
-    steps:
-      - name: Check the generated matrix output
-        run: |
-          echo "Arduino job matrix:"
-          echo "${{ needs.generate_matrix.outputs.arduino_job_matrix }}"
-          echo
-          echo "PlatformIO job matrix"
-          echo "${{ needs.generate_matrix.outputs.pio_job_matrix }}"
-
-  determine_library_source:
-    name: determine_library_source
-    runs-on: ubuntu-latest
-    if: "!contains(github.event.head_commit.message, 'ci skip')"
-    outputs:
-      library_install_zip: ${{ steps.store_vars.outputs.library_install_zip }}
-      library_install_git: ${{ steps.store_vars.outputs.library_install_git }}
-
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Set environment variables for pushes to any branch in EnviroDIY/ModularSensors
-        if: github.event_name == 'push'
-        run: |
-          echo "Push to commit ${GITHUB_SHA}"
-          echo "LIBRARY_INSTALL_ZIP=https://github.com/${GITHUB_REPOSITORY}/archive/${GITHUB_SHA}.zip" >> $GITHUB_ENV
-          echo "LIBRARY_INSTALL_GIT=https://github.com/${GITHUB_REPOSITORY}.git#${GITHUB_SHA}" >> $GITHUB_ENV
-
-      - name: Set environment variable for PR's from any branch in EnviroDIY/ModularSensors
-        if: github.event_name == 'pull_request' && github.event.pull_request.head.repo.name == github.repository
-        run: |
-          echo "Pull Request from the ${GITHUB_HEAD_REF} branch"
-          echo "LIBRARY_INSTALL_ZIP=https://github.com/${GITHUB_REPOSITORY}/archive/${GITHUB_HEAD_REF}.zip" >> $GITHUB_ENV
-          echo "LIBRARY_INSTALL_GIT=https://github.com/${GITHUB_REPOSITORY}.git#${GITHUB_HEAD_REF}" >> $GITHUB_ENV
-
-      - name: Set environment variable for PR's from any branch in EnviroDIY/ModularSensors
-        if: github.event_name == 'pull_request' && github.event.pull_request.head.repo.name != github.repository
-        run: |
-          echo "Pull Request from the fork ${{ github.event.pull_request.head.repo.full_name }} at ${{ github.event.pull_request.head.ref }}"
-          echo "LIBRARY_INSTALL_ZIP=https://github.com/${{ github.event.pull_request.head.repo.full_name }}/archive/${{ github.event.pull_request.head.ref }}.zip" >> $GITHUB_ENV
-          echo "LIBRARY_INSTALL_GIT=https://github.com/${{ github.event.pull_request.head.repo.full_name }}.git#${{ github.event.pull_request.head.ref }}" >> $GITHUB_ENV
-
-      - name: store enviroment variables as output
-        id: store_vars
-        run: |
-          echo "library_install_zip=${{ env.LIBRARY_INSTALL_ZIP }}" >> $GITHUB_OUTPUT
-          echo "library_install_git=${{ env.LIBRARY_INSTALL_GIT }}" >> $GITHUB_OUTPUT
-
-  print_library_source:
-    name: print_library_source
-    runs-on: ubuntu-latest
-    needs: determine_library_source
-    steps:
-      - name: Check the library installation source
-        run: |
-          echo "Link to zip for Arduino CLI testing install:"
-          echo "${{ needs.determine_library_source.outputs.library_install_zip }}"
-          echo
-          echo "Git reference for PlatformIO testing install"
-          echo "${{ needs.determine_library_source.outputs.library_install_git }}"
-
-  build_ex_arduino:
-    name: ${{ matrix.job_info.job_name }}
-    runs-on: ubuntu-latest
-    needs: [generate_matrix, determine_library_source]
-    env:
-      LIBRARY_INSTALL_ZIP: ${{ needs.determine_library_source.outputs.library_install_zip }}
-    strategy:
-      matrix:
-        job_info: ${{ fromJSON(needs.generate_matrix.outputs.arduino_job_matrix) }}
-
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Unused Step
-        run: echo "This is needed to make the step number match with the PlatformIO jobs. =)"
-
-      # We use the `arduino/setup-arduino-cli` action to install and
-      # configure the Arduino CLI on the system.
-      - name: Setup Arduino CLI
-        uses: arduino/[email protected]
-
-      - name: Restore Arduino platforms and libraries
-        uses: actions/cache@v4
-        id: cache_libraries
-        with:
-          path: |
-            home/arduino
-          # if nothing in the dependencies.json file has changed, then it will
-          # be a "cache hit" and we can restore libraries from cache and not
-          # download them.  If it has changed we have to re-download.
-          key: ${{ hashFiles('./continuous_integration/dependencies.json','continuous_integration/install-deps-arduino-cli.sh') }}
-
-      # Install cores and library dependencies for the Arduino CLI, iff no cache
-      - name: Install the Arduino libraries
-        if: steps.cache_libraries.outputs.cache-hit != 'true'
-        run: |
-          chmod +x continuous_integration/install-deps-arduino-cli.sh
-          sh continuous_integration/install-deps-arduino-cli.sh
-
-      # Install ModularSensors for the Arduino CLI
-      - name: Install the testing version of Modular Sensors for the Arduino CLI
-        run: |
-          chmod +x continuous_integration/install-test-version-arduino-cli.sh
-          sh continuous_integration/install-test-version-arduino-cli.sh
-
-      - name: Download the prepared examples
-        uses: actions/download-artifact@v4
-        with:
-          name: generated_examples
-          path: |
-            continuous_integration_artifacts/
-
-      - name: Include problem matcher
-        uses: ammaraskar/gcc-problem-matcher@master
-
-      # Run the script to compile the examples
-      - name: Compile
-        env:
-          ACTION_RUN_ID: ${{ github.run_id }}
-        run: |
-          chmod +x ${{ matrix.job_info.script }}
-          bash ${{ matrix.job_info.script }}
-
-      # NOTE:  Don't uninstall for PlatformIO because the library manager will clean up the
-      # dependencies leaving nothing for the cache
-      # pio pkg uninstall --library -g EnviroDIY_ModularSensors
-      - name: Uninstall testing version of Modular Sensors before caching
-        run: |
-          arduino-cli --config-file continuous_integration/arduino_cli.yaml lib uninstall ModularSensors
-
-  build_pio:
-    name: ${{ matrix.job_info.job_name }}
-    runs-on: ubuntu-latest
-    needs: [generate_matrix, determine_library_source]
-    env:
-      LIBRARY_INSTALL_GIT: ${{ needs.determine_library_source.outputs.library_install_git }}
-    strategy:
-      matrix:
-        job_info: ${{ fromJSON(needs.generate_matrix.outputs.pio_job_matrix) }}
-
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Set up Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: '3.x'
-          cache: 'pip'
-
-      - name: Install python dependencies, including PlatformIO
-        run: pip install -r continuous_integration/requirements.txt
-
-      - name: Restore PlatformIO platforms and libraries
-        uses: actions/cache@v4
-        id: cache_libraries
-        with:
-          path: |
-            ~/.platformio
-          # if nothing in the dependencies.json file has changed, then it will
-          # be a "cache hit" and we can restore libraries from cache and not
-          # download them.  If it has changed we have to re-download.
-          key: ${{ hashFiles('./continuous_integration/dependencies.json','continuous_integration/install-deps-platformio.sh') }}
-
-      # Install the dependencies for PlatformIO
-      - name: Install the PlatformIO dependencies at global level
-        if: steps.cache_libraries.outputs.cache-hit != 'true'
-        run: |
-          chmod +x continuous_integration/install-deps-platformio.sh
-          sh continuous_integration/install-deps-platformio.sh
-          cp -a /home/runner/.platformio/lib/. $GITHUB_WORKSPACE/lib/
-
-      # Install ModularSensors at the Global level for PlatformIO
-      # Force install to get the right version
-      - name: Install the testing version of Modular Sensors for PlatformIO
-        run: |
-          pio pkg install -g --library ${{ env.LIBRARY_INSTALL_GIT }}
-
-      - name: Download the prepared examples
-        uses: actions/download-artifact@v4
-        with:
-          name: generated_examples
-          path: |
-            continuous_integration_artifacts/
-
-      - name: Include problem matcher
-        uses: ammaraskar/gcc-problem-matcher@master
-
-      # Run the script to compile the examples
-      - name: Compile
-        env:
-          ACTION_RUN_ID: ${{ github.run_id }}
-        run: |
-          chmod +x ${{ matrix.job_info.script }}
-          bash ${{ matrix.job_info.script }}
+  build_examples:
+    name: Build all examples with PlatformIO and the Arduino CLI
+    if: ${{ ! contains(github.event.head_commit.message, 'ci skip') }}
+    uses: EnviroDIY/workflows/.github/workflows/build_examples.yaml@main
+    with:
+      boards_to_build: 'mayfly,megaatmega2560,zeroUSB,adafruit_feather_m0'
+    secrets: inherit

.github/workflows/changelog_reminder.yaml

@@ -12,7 +12,7 @@ jobs:
       - name: Changelog Reminder
         uses: peterjgrainger/[email protected]
         with:
-          changelog_regex: '/CHANGELOG\/.*\/*.md'
+          changelog_regex: '/CHANGELOG\/.*\/*.md/i'
           customPrMessage: 'Please add your changes to the change log!'
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}