Merge pull request #478 from EnviroDIY/develop

Develop

Author: SRGDamia1

.actrc

@@ -0,0 +1,5 @@
+--platform ubuntu-latest=ghcr.io/catthehacker/ubuntu:full-latest
+--pull=false
+--detect-event
+--env RUNNER_DEBUG=1           # Enable debug logging
+# --env NODE_DEBUG=<module>    # Might be useful in few cases

.github/workflows/build_documentation.yaml

@@ -28,6 +28,53 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
+  check_menu_inclusion:
+    runs-on: ubuntu-latest
+    if: ${{ ! contains(github.event.head_commit.message, 'ci skip') }}
+    name: Check that all classes are documented in the menu-a-la-carte example
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.x'
+
+      # Using answer from here to get the exit code and pass the output:  https://stackoverflow.com/questions/59191913/how-do-i-get-the-output-of-a-specific-step-in-github-actions
+      - name: check for classes in the menu example
+        id: check_component
+        continue-on-error: true
+        run: |
+          cd $GITHUB_WORKSPACE/continuous_integration
+          python check_component_inclusion.py 2>&1 | tee check_component.log
+          result_code=${PIPESTATUS[0]}
+          missing_menu_docs=$(cat check_component.log)
+          missing_menu_docs="${missing_menu_docs//'%'/'%25'}"
+          missing_menu_docs="${missing_menu_docs//$'\n'/'%0A'}"
+          missing_menu_docs="${missing_menu_docs//$'\r'/'%0D'}"
+          echo "missing_menu_docs=missing_menu_docs" >> $GITHUB_OUTPUT
+          if [[ $result_code ]]; then
+            echo "$(cat check_component.log)" >> $GITHUB_STEP_SUMMARY
+          else
+            echo "Valid library.json =)" >> $GITHUB_STEP_SUMMARY
+          fi
+          echo "Finished menu inclusion verification"
+          exit $result_code
+
+      - name: Create commit comment
+        uses: peter-evans/commit-comment@v3
+        if: steps.check_component.outcome=='failure'
+        with:
+          body: |
+            All sensor and variable subclasses must be included in the Menu a la Carte example
+            ${{ steps.check_component.outputs.missing_menu_docs }}
+
+      - name: Fail if cannot find all menu flags
+        id: verification_failure
+        if: steps.check_component.outcome=='failure'
+        run: exit 1
+
   doc_build:
     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

.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 }}

.gitignore

@@ -106,3 +106,9 @@ runDoxygen_archive.bat
 generateKeywords.bat
 update_path.bat
 pio_common_libdeps.ini
+ex_one_offs/*
+output_deep.txt
+output_deep+.txt
+envDump.txt
+-Q
+act.log