feat: add cargo-wdk cargo extension (#306)

Signed-off-by: Shravan Vasista <[email protected]>
Signed-off-by: Leon Durrenberger <[email protected]>
Co-authored-by: krishnakumar4a4 <[email protected]>
Co-authored-by: Krishna Kumar Thokala <[email protected]>
Co-authored-by: Leon Durrenberger <[email protected]>
Co-authored-by: leon-xd <[email protected]>
Co-authored-by: Melvin Wang <[email protected]>

Author: 5 people

.github/workflows/build.yaml

@@ -34,8 +34,10 @@ jobs:
           - release
 
         target_triple:
-          - x86_64-pc-windows-msvc
-          - aarch64-pc-windows-msvc
+          - name: x86_64-pc-windows-msvc
+            arch: amd64
+          - name: aarch64-pc-windows-msvc
+            arch: arm64
 
     steps:
       - name: Checkout Repository
@@ -70,21 +72,32 @@ jobs:
         uses: dtolnay/rust-toolchain@master
         with:
           toolchain: ${{ matrix.rust_toolchain }}
-          targets: ${{ matrix.target_triple }}
+          targets: |
+            ${{ matrix.target_triple.name }}
 
       - name: Run Cargo Build
-        run: cargo +${{ matrix.rust_toolchain }} build --locked --profile ${{ matrix.cargo_profile }} --target ${{ matrix.target_triple }} --workspace --all-features
+        run: cargo +${{ matrix.rust_toolchain }} build --locked --profile ${{ matrix.cargo_profile }} --target ${{ matrix.target_triple.name }} --workspace --all-features
 
       - name: Install Cargo Make
         uses: taiki-e/install-action@v2
         with:
           tool: cargo-make
 
       - name: Run Cargo Make (package-driver-flow) in Workspace
-        run: cargo make package-driver-flow +${{ matrix.rust_toolchain }} --locked --profile ${{ matrix.cargo_profile }} --target ${{ matrix.target_triple }} --workspace
+        run: cargo make package-driver-flow +${{ matrix.rust_toolchain }} --locked --profile ${{ matrix.cargo_profile }} --target ${{ matrix.target_triple.name }} --workspace
 
       - name: Build Examples (via Cargo Make)
-        run: cargo make --cwd ./examples build +${{ matrix.rust_toolchain }} --locked --profile ${{ matrix.cargo_profile }} --target ${{ matrix.target_triple }}
+        run: cargo make --cwd ./examples build +${{ matrix.rust_toolchain }} --locked --profile ${{ matrix.cargo_profile }} --target ${{ matrix.target_triple.name }}
 
       - name: Package Examples (via Cargo Make)
-        run: cargo make --cwd ./examples package-driver-flow +${{ matrix.rust_toolchain }} --locked --profile ${{ matrix.cargo_profile }} --target ${{ matrix.target_triple }}
+        run: cargo make --cwd ./examples package-driver-flow +${{ matrix.rust_toolchain }} --locked --profile ${{ matrix.cargo_profile }} --target ${{ matrix.target_triple.name }}
+
+      # Run cargo-wdk on examples
+      - name: Install cargo-wdk
+        run: cargo +${{ matrix.rust_toolchain }} install --path=crates/cargo-wdk --profile ${{ matrix.cargo_profile }} --locked --force
+
+      - name: Build & Package Examples (via cargo-wdk)
+        run: cargo +${{ matrix.rust_toolchain }} wdk build --cwd ./examples --profile ${{ matrix.cargo_profile }} --target-arch ${{ matrix.target_triple.arch }} --sample
+
+      - name: Run build on tests folder (via cargo-wdk)
+        run: cargo +${{ matrix.rust_toolchain }} wdk build --cwd ./tests --profile ${{ matrix.cargo_profile }} --target-arch ${{ matrix.target_triple.arch }}

.github/workflows/code-formatting-check.yaml

@@ -41,3 +41,24 @@ jobs:
 
       - run: taplo fmt --check --diff
         name: Check TOML files formatting
+
+  cargo-sort:
+    name: Check Dependencies are sorted lexicographically
+    runs-on: windows-latest
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+
+      - name: Install Rust Toolchain (Stable)
+        uses: dtolnay/rust-toolchain@stable
+
+      # Installing cargo-sort from main branch since there is an unreleased fix
+      # Ref: https://github.com/DevinR528/cargo-sort/issues/67#issuecomment-2486868511
+      - name: Install cargo-sort binary from specific branch
+        run: cargo install --git=https://github.com/DevinR528/cargo-sort cargo-sort --branch main --rev 4a1ecf093649b87fa610aec32a1bdaa4829d416b --locked --force
+
+      # -w for every crate in workspace, -g for keeping blank lines when sorting groups of deps,
+      # -n do not run formatting, --check to only check without modifying files
+      - run: cargo sort -g -w -n --check
+        name: Check if dependencies in Cargo.toml are sorted

.gitignore

@@ -1 +1,4 @@
 target/
+
+# ignore lock file created during cargo-wdk's integration test runs
+crates/cargo-wdk/cargo-wdk-test.lock

CONTRIBUTING.md

@@ -137,6 +137,8 @@ To maintain the quality of code, tests and tools are required to pass before con
   * `+nightly` is required to use some `nightly` configuration features in [the `rustfmt.toml` config](./rustfmt.toml)
 * Check for consistent `.toml` file formatting: `taplo fmt --check --diff`
   * Running `taplo fmt` resolves these formatting inconsistencies usually
+* Check for sorted sections and dependencies listed in the `Cargo.toml` files: `cargo sort -w -g -n --check`
+  * Running `cargo sort -w -g -n` resolves any formatting inconsistencies.
 
 **_Dependency Analysis:_**