CI: Add lint workflow

We now ensure that the `clippy` and `rustfmt` components are installed
for the `crates` MSRV via the `rust-toolchain.toml` file.

Author: str4d

.github/workflows/_build_and_test.yml

@@ -9,6 +9,7 @@ on:
 
 jobs:
   build-and-test:
+    name: Build and test
     runs-on: ubuntu-latest
     defaults:
       run:

.github/workflows/_lints.yml

@@ -0,0 +1,75 @@
+name: Reusable workflow for lints
+
+on:
+  workflow_call:
+    inputs:
+      target:
+        required: true
+        type: string
+
+jobs:
+  clippy:
+    name: Clippy (MSRV)
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ${{ inputs.target }}
+    steps:
+      - uses: actions/checkout@v3
+      - name: Install build dependencies
+        run: sudo apt install libudev-dev
+      - name: Run Clippy
+        uses: auguwu/[email protected]
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          working-directory: ${{ inputs.target }}
+          args: --all-features --all-targets -- -D warnings
+
+  clippy-beta:
+    name: Clippy (beta)
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    defaults:
+      run:
+        working-directory: ${{ inputs.target }}
+    steps:
+      - uses: actions/checkout@v3
+      - name: Install build dependencies
+        run: sudo apt install libudev-dev
+      - uses: dtolnay/rust-toolchain@beta
+        id: toolchain
+        with:
+          components: clippy
+      - run: rustup override set ${{ steps.toolchain.outputs.name }}
+      - name: Run Clippy (beta)
+        uses: auguwu/[email protected]
+        continue-on-error: true
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          working-directory: ${{ inputs.target }}
+          args: --all-features --all-targets -- -W clippy::all
+
+  doc-links:
+    name: Intra-doc links
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ${{ inputs.target }}
+    steps:
+      - uses: actions/checkout@v3
+      - name: Install build dependencies
+        run: sudo apt install libudev-dev
+      - run: cargo fetch
+      # Requires #![deny(rustdoc::broken_intra_doc_links)] in crates.
+      - name: Check intra-doc links
+        run: cargo doc --workspace --document-private-items
+
+  fmt:
+    name: Rustfmt
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ${{ inputs.target }}
+    steps:
+      - uses: actions/checkout@v3
+      - run: cargo fmt --all --check

.github/workflows/lints.yml

@@ -0,0 +1,17 @@
+name: Lints
+
+# We only run these lints on trial-merges of PRs to reduce noise.
+on:
+  pull_request:
+    branches: ["main"]
+
+jobs:
+  crates:
+    uses: ./.github/workflows/_lints.yml
+    with:
+      target: crates
+
+  tools:
+    uses: ./.github/workflows/_lints.yml
+    with:
+      target: tools

.github/workflows/rust.yml

@@ -10,7 +10,7 @@ env:
   CARGO_TERM_COLOR: always
 
 jobs:
-  build:
+  crates:
     uses: ./.github/workflows/_build_and_test.yml
     with:
       target: crates

crates/alloc/src/lib.rs

@@ -2,6 +2,7 @@
 //! *Note:* This currently requires using nightly.
 
 #![no_std]
+#![deny(rustdoc::broken_intra_doc_links)]
 
 use core::alloc::{GlobalAlloc, Layout};
 use core::ffi::c_void;

crates/flipperzero/src/lib.rs

@@ -2,6 +2,7 @@
 
 #![no_std]
 #![cfg_attr(test, no_main)]
+#![deny(rustdoc::broken_intra_doc_links)]
 
 #[cfg(feature = "alloc")]
 extern crate alloc;

crates/rt/src/lib.rs

@@ -4,6 +4,7 @@
 //! is linked directly into the `.text` section.
 
 #![no_std]
+#![deny(rustdoc::broken_intra_doc_links)]
 
 pub mod manifest;
 pub mod panic_handler;

crates/rust-toolchain.toml

@@ -1,3 +1,4 @@
 [toolchain]
 channel = "nightly-2023-05-03"
 targets = [ "thumbv7em-none-eabihf" ]
+components = [ "clippy", "rustfmt" ]

crates/sys/src/lib.rs

@@ -1,6 +1,7 @@
 //! Low-level bindings for the Flipper Zero.
 
 #![no_std]
+#![deny(rustdoc::broken_intra_doc_links)]
 
 // Features that identify thumbv7em-none-eabihf.
 // Until target_abi is stable, this also permits thumbv7em-none-eabi.
@@ -20,6 +21,7 @@ mod inlines;
 #[allow(non_upper_case_globals)]
 #[allow(non_camel_case_types)]
 #[allow(non_snake_case)]
+#[allow(rustdoc::broken_intra_doc_links)]
 mod bindings;
 
 /// Create a static C string.

crates/test/src/lib.rs

@@ -1,4 +1,5 @@
 #![no_std]
+#![deny(rustdoc::broken_intra_doc_links)]
 
 pub use flipperzero_test_macros::{tests, tests_runner};
 

tools/src/lib.rs

@@ -1,2 +1,4 @@
-pub mod storage;
+#![deny(rustdoc::broken_intra_doc_links)]
+
 pub mod serial;
+pub mod storage;