Merge pull request #1027 from quartiq/miniconf-schema

Miniconf schema

Author: jordens

.github/workflows/ci.yml

@@ -15,36 +15,22 @@ jobs:
   style:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions-rs/toolchain@v1
-        with:
-          toolchain: stable
-          target: thumbv7em-none-eabihf
-          override: true
-      - name: cargo fmt --check
-        uses: actions-rs/cargo@v1
-        with:
-          command: fmt
-          args: --all -- --check
-      - uses: actions-rs/clippy-check@v1
-        with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-      - name: cargo check
-        uses: actions-rs/cargo@v1
-        with:
-          command: check
-          args: --verbose
-
+      - uses: actions/checkout@v5
+      - uses: dtolnay/rust-toolchain@stable
+        with:
+          targets: thumbv7em-none-eabihf
+          components: clippy,rustfmt
+      - run: cargo fmt --all -- --check
+      - run: cargo clippy
+      - run: cargo check --all --verbose
       - uses: actions/setup-python@v1
         with:
           python-version: 3.12
-      - name: Install Python Dependencies
-        run: |
+      - run: |
             python -m pip install --upgrade pip
             pip install py/
             pip install pylint
-      - name: Run Pylint
-        run: |
+      - run: |
           pylint py/stabilizer
 
   compile:
@@ -63,68 +49,51 @@ jobs:
             features: nightly
             continue-on-error: true
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions-rs/toolchain@v1
+      - uses: actions/checkout@v5
+      - uses: dtolnay/rust-toolchain@master
         with:
           toolchain: ${{ matrix.toolchain }}
-          target: thumbv7em-none-eabihf
-          override: true
-      - uses: actions-rs/cargo@v1
-        with:
-          command: build
-          args: --release --features "${{ matrix.features }}"
+          targets: thumbv7em-none-eabihf
+      - run: cargo build --release --features "${{ matrix.features }}"
 
-  doc:
+  schema:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v5
+      - uses: dtolnay/rust-toolchain@stable
+      # https://github.com/rust-lang/cargo/issues/13051
+      - run: cargo run --bin dual-iir --target x86_64-unknown-linux-gnu
+      - run: cargo run --bin lockin --target x86_64-unknown-linux-gnu
+      - run: cargo run --bin dds --target x86_64-unknown-linux-gnu
 
-      - uses: actions-rs/toolchain@v1
+  doc:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - uses: dtolnay/rust-toolchain@stable
         with:
-          toolchain: stable
-          target: thumbv7em-none-eabihf
-          override: true
-
+          targets: thumbv7em-none-eabihf
       - uses: Swatinem/rust-cache@v1
-
       - uses: peaceiris/actions-mdbook@v1
         with:
           mdbook-version: '0.4.12'
-
-      - name: Install Deadlinks
-        uses: actions-rs/cargo@v1
-        with:
-          command: install
-          args: |
-            cargo-deadlinks
-
-      - name: Install Linkcheck
-        uses: actions-rs/cargo@v1
-        with:
-          command: install
-          args: mdbook-linkcheck
-
-      - name: cargo doc
-        uses: actions-rs/cargo@v1
-        with:
-          command: doc
-          args: --no-deps -p miniconf -p idsp -p ad9959 -p stabilizer
-
-      - name: cargo deadlinks
-        uses: actions-rs/cargo@v1
+      - run: cargo install cargo-deadlinks
+      - run: cargo install mdbook-linkcheck
+      - run: |
+          cargo doc --no-deps \
+            -p miniconf -p idsp \
+            -p ad9959 -p ad9912 -p stream -p platform -p signal_generator \
+            -p encoded_pin -p serial_settings -p urukul \
+            -p stabilizer
+      # We intentionally ignore fragments, as RTIC may generate fragments for various
+      # auto-generated code.
+      - run: cargo deadlinks --dir target/thumbv7em-none-eabihf/doc --ignore-fragments --check-intra-doc-links
         continue-on-error: true
-        with:
-          command: deadlinks
-          # We intentionally ignore fragments, as RTIC may generate fragments for various
-          # auto-generated code.
-          args: --dir target/thumbv7em-none-eabihf/doc --ignore-fragments --check-intra-doc-links
-
-      - name: Test Book
-        working-directory: book
+      - name: build
         run: |
-          # Install depedencies at our cache location
           mv ../target/thumbv7em-none-eabihf/doc src/firmware
           mdbook build
+        working-directory: book
 
   hitl-trigger:
     runs-on: ubuntu-latest

.github/workflows/docs.yml

@@ -10,39 +10,30 @@ jobs:
   release-docs:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v5
         with:
             fetch-depth: 0
-
-      - uses: actions-rs/toolchain@v1
+      - uses: dtolnay/rust-toolchain@stable
         with:
-          toolchain: stable
-          target: thumbv7em-none-eabihf
-          override: true
-
+          targets: thumbv7em-none-eabihf
       - uses: Swatinem/rust-cache@v1
-
-      - name: Install Linkcheck
-        uses: actions-rs/cargo@v1
+      - uses: actions-rs/cargo@v1
         with:
           command: install
           args: mdbook-linkcheck
-
       - uses: peaceiris/actions-mdbook@v1
         with:
           mdbook-version: '0.4.12'
-
-      - uses: actions-rs/cargo@v1
-        with:
-          command: doc
-          args: --no-deps -p miniconf -p ad9959 -p stabilizer -p idsp -p urukul -p serial-settings
-
-      - name: Build Book
-        working-directory: book
+      - run: |
+          cargo doc --no-deps \
+            -p miniconf -p idsp \
+            -p ad9959 -p ad9912 -p stream -p platform -p signal_generator \
+            -p encoded_pin -p serial_settings -p urukul \
+            -p stabilizer
+      - working-directory: book
         run: |
           mv ../target/thumbv7em-none-eabihf/doc src/firmware
           mdbook build
-
       - uses: peaceiris/actions-gh-pages@v3.8.0
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}