Merge pull request #407 from EnviroDIY/develop

Develop

Author: SRGDamia1

.github/workflows/build_documentation.yaml

@@ -1,18 +1,51 @@
-name: Build and Publish Documentation
+name: Check and Publish Documentation
 
 on:
+  # Triggers the workflow on push or pull request events
+  push:
+  pull_request:
   # Trigger when a release is created
   release:
     types:
       - published
   # Also give a manual trigger
   workflow_dispatch:
+    inputs:
+      publish:
+        description: 'Publish Documentation to GitHub Pages'
+        required: false
+        type: boolean
+        default: false
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
 
 env:
-  DOXYGEN_VERSION: Release_1_9_2
+  REBUILD_CACHE_NUMBER: 2
+  PYTHON_DEPS_ARCHIVE_NUM: 2
+  DOXYGEN_VERSION: Release_1_9_3
+  TEX_VERSION: 2019
+  # ^^ 2019 is the latest TeX live available on apt-get and that's good enough
+  GRAPHVIZ_VERSION: 2.43.0
 
 jobs:
-  build:
+  check_menu_inclusion:
+    runs-on: ubuntu-latest
+    if: "!contains(github.event.head_commit.message, 'ci skip')"
+
+    steps:
+      - uses: actions/checkout@v2.4.0
+
+      - name: Set up Python
+        uses: actions/setup-python@v3
+
+      - name: check for classes in the menu example
+        run: |
+          cd $GITHUB_WORKSPACE/continuous_integration
+          python check_component_inclusion.py
+
+  doc_build:
     runs-on: ubuntu-latest
     if: "!contains(github.event.head_commit.message, 'ci skip')"
 
@@ -30,25 +63,24 @@ jobs:
         id: cache_python
         with:
           path: ~/.cache/pip
-          key: ${{ runner.os }}-doxygen-${{ env.DOXYGEN_VERSION }}
+          key: ${{ runner.os }}-python-${{ env.REBUILD_CACHE_NUMBER }}-${{ env.PYTHON_DEPS_ARCHIVE_NUM }}
 
       - name: Install Pygments and other m.css Python Requirements
-        if: steps.cache_python.outputs.cache-hit != 'true'
         run: |
           python -m pip install --upgrade pip
-          pip3 install --upgrade --upgrade-strategy jinja2 Pygments beautifulsoup4
-
-      - name: Install GraphViz (dot)
-        run: sudo apt-get -y install graphviz
+          pip3 install --upgrade --upgrade-strategy only-if-needed jinja2 Pygments beautifulsoup4
 
-      - name: Restore Doxygen
+      - name: Restore Doxygen, Graphviz, and TeX Live
         id: cache_doxygen
         uses: actions/cache@v3
         with:
-          path: doxygen-src
-          key: ${{ runner.os }}-doxygen-${{ env.DOXYGEN_VERSION }}
+          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: Clone and build doxygen
+      - name: Build and install doxygen and its dependencies
         if: steps.cache_doxygen.outputs.cache-hit != 'true'
         env:
           TRAVIS_BUILD_DIR: ${{ github.workspace }}
@@ -74,6 +106,7 @@ jobs:
           sh continuous_integration/generate-documentation.sh
 
       - 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/actions-gh-pages@v3.8.0
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/build_examples_arduino_cli.yaml

@@ -3,6 +3,10 @@ name: Build Examples with Arduino CLI
 # Triggers the workflow on push or pull request events
 on: [push, pull_request]
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
   build:
     runs-on: ubuntu-latest
@@ -19,6 +23,7 @@ jobs:
             examples/DRWI_2G/,
             examples/DRWI_DigiLTE/,
             examples/DRWI_SIM7080LTE/,
+            examples/DRWI_Mayfly1/,
             examples/double_logger/,
             examples/baro_rho_correction/,
             examples/data_saving/,

.github/workflows/build_examples_platformio.yaml

@@ -2,6 +2,9 @@ name: Build Examples with PlatformIO
 
 # Triggers the workflow on push or pull request events
 on: [push, pull_request]
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
 
 jobs:
   build:
@@ -19,6 +22,7 @@ jobs:
             examples/DRWI_2G/,
             examples/DRWI_DigiLTE/,
             examples/DRWI_SIM7080LTE/,
+            examples/DRWI_Mayfly1/,
             examples/double_logger/,
             examples/baro_rho_correction/,
             examples/data_saving/,