Sync missing-doc-variants branch to master

.github/actions/list-BSPs/action.yml

@@ -12,5 +12,5 @@ runs:
     - id: compute-matrix
       shell: bash
       run: |
-        matrix_json=$(cat crates.json | jq -Mr -c '{ "bsp": (.boards | keys ), "toolchain": ["stable", "nightly"] }')
+        matrix_json=$(cat crates.json | jq -Mr -c '{ "bsp": [ (.boards | to_entries | .[] | {"name": (.key), "tier": .value.tier}) ] , "toolchain": ["stable", "nightly"] }')
         echo "matrix=${matrix_json}" >> $GITHUB_OUTPUT

.github/dependabot.yml

@@ -0,0 +1,7 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    # Check for updates every Monday
+    schedule:
+      interval: "weekly"

.github/pull_request_template.md

@@ -4,7 +4,7 @@
 # Checklist
   - [ ] `CHANGELOG.md` for the BSP or HAL updated
   - [ ] All new or modified code is well documented, especially public items
-  - [ ] No new warnings or clippy suggestions have been introduced (see CI or check locally)
+  - [ ] No new warnings or clippy suggestions have been introduced - CI will **deny** clippy warnings by default! You may `#[allow]` certain lints where reasonable, but ideally justify those with a short comment. 
 
 ## If Adding a new Board
   - [ ] Board CI added to `crates.json`

.github/workflows/build-bsp.yml

@@ -8,43 +8,89 @@ jobs:
       matrix: ${{ steps.set-matrix.outputs.matrix }}
     steps:
     - name: Checkout sources
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
     - id: set-matrix
       uses: ./.github/actions/list-BSPs
 
   build:
+    name: "${{matrix.bsp.name}} (Tier ${{matrix.bsp.tier}}, ${{matrix.toolchain}})"
     runs-on: ubuntu-latest
-    continue-on-error: ${{ matrix.toolchain == 'nightly' }}
+    # There is a subtle difference between continue-on-error and setting
+    # strategy.fail-fast=false.  Both will allow all jobs to run to completion,
+    # however continue-on-error lets the next workflow stage run regardless of
+    # failed jobs, strategy.fail-fast=false will skip subsequent stages if any
+    # job fails.
+    continue-on-error: true
     needs: setup
     strategy:
       matrix: ${{fromJson(needs.setup.outputs.matrix)}}
     steps:
     - name: Checkout sources
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
 
     - name: Install Rust
       run: |
         rustup set profile minimal
         rustup override set ${{ matrix.toolchain }}
-        target=$(cat ./crates.json | jq -Mr --arg board '${{ matrix.bsp }}' -c '.boards | .[$board] | .target')
+        target=$(cat ./crates.json | jq -Mr --arg board '${{ matrix.bsp.name }}' -c '.boards | .[$board] | .target')
         rustup target add ${target}
         rustup component add clippy
 
     - name: Setup cache
       uses: Swatinem/rust-cache@v2
 
-    - name: Build ${{ matrix.bsp }}
+    - name: Build ${{ matrix.bsp.name }}
       run: |
-        build_invocation=$(cat ./crates.json | jq -Mr --arg board '${{ matrix.bsp }}' -c '.boards | .[$board] | .build')
+        build_invocation=$(cat ./crates.json | jq -Mr --arg board '${{ matrix.bsp.name }}' -c '.boards | .[$board] | .build')
         set -ex
-        cd boards/${{ matrix.bsp }}
+        pushd boards/${{ matrix.bsp.name }}
         $(${build_invocation})
+        popd
+        mkdir -p output
+        touch "output/build"
 
-    - name: Clippy ${{ matrix.bsp }}
+    - name: Clippy ${{ matrix.bsp.name }}
       if: ${{ matrix.toolchain == 'nightly' }}
       run: |
         set -ex
-        build_invocation=$(cat ./crates.json | jq -Mr --arg board '${{ matrix.bsp }}' -c '.boards | .[$board] | .build')
+        build_invocation=$(cat ./crates.json | jq -Mr --arg board '${{ matrix.bsp.name }}' -c '.boards | .[$board] | .build')
         clippy_invocation=$(echo ${build_invocation} | sed 's/cargo build/cargo clippy/g')
-        cd boards/${{ matrix.bsp }}
+        cd boards/${{ matrix.bsp.name }}
         $(${clippy_invocation})
+
+    - name: Done
+      uses: actions/upload-artifact@v4
+      with:
+        # name needs to be unique in the workspace
+        name: "${{ matrix.bsp.name }}-${{ matrix.toolchain }}"
+        path: output
+
+  check-tier-1-bsps-build-stable:
+    runs-on: ubuntu-latest
+    needs: [setup, build]
+    steps:
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          path: successful-jobs
+      - name: Do checks
+        env:
+          MATRIX: ${{ needs.setup.outputs.matrix }}
+        run: |
+          tier_1_bsps=$(jq -Mr -c '.bsp[] | select(.tier == 1) | .name' <<< ${MATRIX})
+
+          success="true"
+          for bsp in ${tier_1_bsps}; do
+            if [ -f successful-jobs/"${bsp}"-stable/build ]; then
+              echo "${bsp}" built on stable toolchain
+            else
+              echo "${bsp}" failed to build on stable toolchain
+              success="false"
+            fi
+          done
+
+          if [ ${success} = "true" ]; then
+            echo "Tier 1 BSPs all built on stable"
+          else
+            false
+          fi

.github/workflows/build-hal.yml

@@ -8,7 +8,7 @@ jobs:
       matrix: ${{ steps.set-matrix.outputs.matrix }}
     steps:
     - name: Checkout sources
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
     - id: set-matrix
       uses: ./.github/actions/list-HAL-variants
 
@@ -20,7 +20,7 @@ jobs:
       matrix: ${{fromJson(needs.setup.outputs.matrix)}}
     steps:
     - name: Checkout sources
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
 
     - name: Install Rust
       run: |
@@ -38,12 +38,4 @@ jobs:
         set -ex
         features=$(cat ./crates.json | jq -Mr --arg pac "${{matrix.pac}}" -c '.hal_variants["${{matrix.pac}}"].features | join(",")')
         target=$(cat ./crates.json | jq -Mr --arg pac "${{matrix.pac}}" -c '.hal_variants["${{matrix.pac}}"].target')
-        cargo build --features=${features} --target=${target} --manifest-path=./hal/Cargo.toml
-
-    - name: Clippy HAL for ${{ matrix.pac }}
-      if: ${{ matrix.toolchain == 'nightly' }}
-      run: |
-        set -ex
-        features=$(cat ./crates.json | jq -Mr --arg pac "${{matrix.pac}}" -c '.hal_variants["${{matrix.pac}}"].features | join(",")')
-        target=$(cat ./crates.json | jq -Mr --arg pac "${{matrix.pac}}" -c '.hal_variants["${{matrix.pac}}"].target')
-        cargo clippy --features=${features} --target=${target} --manifest-path=./hal/Cargo.toml
+        cargo clippy --features=${features} --target=${target} --manifest-path=./hal/Cargo.toml -- -D warnings

.github/workflows/generate-docs.yml

@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout sources
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Install Rust
         run: |