feat(rust-build)!: enhance Rust workflow with linting and formatting

.github/workflows/rust-build.yml

@@ -7,10 +7,14 @@ on:
         description: 'Rust version to use'
         default: 'stable'
         type: string
-      build-target:
+      build-profile:
         description: 'Cargo profile to use for building (debug, release)'
         default: 'release'
         type: string
+      run-audit:
+        description: 'Run cargo-audit for security vulnerabilities'
+        default: true
+        type: boolean
       enable-cache:
         description: 'Enable caching of dependencies'
         default: true
@@ -35,41 +39,55 @@ on:
       CRATES_IO_TOKEN:
         required: false
 
+env:
+  CARGO_TERM_COLOR: always
+
 jobs:
   build:
     runs-on: ubuntu-latest
-    outputs:
-      build_success: ${{ steps.set-output.outputs.build_success }}
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
 
       - name: Install Rust toolchain
-        uses: actions-rs/toolchain@v1
+        uses: dtolnay/rust-toolchain@stable
         with:
-          profile: minimal
           toolchain: ${{ inputs.rust-version }}
-          override: true
+          components: clippy, rustfmt
 
       - name: Cache dependencies
         if: ${{ inputs.enable-cache }}
         uses: actions/cache@v4
         with:
           path: |
-            ~/.cargo/registry
+            ~/.cargo/bin/
+            ~/.cargo/registry/index/
+            ~/.cargo/registry/cache/
             ~/.cargo/git
             target
-          key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
+          key: ${{ runner.os }}-cargo-${{ inputs.build-profile }}-${{ hashFiles('**/Cargo.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-cargo-${{ inputs.build-profile }}-
+
+      - name: Check formatting
+        run: cargo fmt --all -- --check
+
+      - name: Run linter (Clippy)
+        run: cargo clippy --all-targets -- -D warnings
+
+      - name: Install cargo-audit
+        if: ${{ inputs.run-audit }}
+        run: cargo install cargo-audit
+
+      - name: Run security audit
+        if: ${{ inputs.run-audit }}
+        run: cargo audit
 
       - name: Build
-        run: cargo build --profile ${{ inputs.build-target }}
+        run: cargo build --profile ${{ inputs.build-profile }}
 
       - name: Run tests
-        run: cargo test --profile ${{ inputs.build-target }}
-
-      - name: Set build success output
-        id: set-output
-        run: echo "build_success=true" >> $GITHUB_OUTPUT
+        run: cargo test --profile ${{ inputs.build-profile }}
 
       - name: Upload artifact
         if: ${{ inputs.upload-artifact }}
@@ -80,24 +98,20 @@ jobs:
 
   publish:
     needs: build
-    if: ${{ inputs.publish-crates-io && needs.build.outputs.build_success == 'true' }}
+    if: ${{ inputs.publish-crates-io && needs.build.result == 'success' }}
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
 
       - name: Install Rust toolchain
-        uses: actions-rs/toolchain@v1
+        uses: dtolnay/rust-toolchain@stable
         with:
-          profile: minimal
           toolchain: ${{ inputs.rust-version }}
-          override: true
-
-      - name: Login to crates.io
-        run: cargo login ${{ secrets.CRATES_IO_TOKEN }}
+          components: cargo
 
-      - name: Package for crates.io
-        run: cargo package
+      - name: Validate package
+        run: cargo package --allow-dirty
 
       - name: Publish to crates.io
-        run: cargo publish
+        run: cargo publish --token ${{ secrets.CRATES_IO_TOKEN }}

rust-build/README.md

@@ -1,13 +1,16 @@
 # Rust Build Workflow
 
-A reusable GitHub Actions workflow for building, testing, and publishing Rust packages.
+A reusable GitHub Actions workflow for building, linting, testing, and auditing Rust packages, with optional artifact upload and crates.io publishing.
 
 ## Features
 
 - Build and test Rust packages
+- Lint code using `clippy`
+- Check formatting with `cargo fmt`
+- Run security audits with `cargo audit`
 - Cache dependencies for faster builds
-- Publish packages to crates.io
 - Upload build artifacts
+- Publish to crates.io
 
 ## Usage
 
@@ -21,30 +24,34 @@ jobs:
     uses: iExecBlockchainComputing/github-actions-workflows/.github/workflows/rust-build.yml@main
     with:
       rust-version: 'stable'
-      build-target: 'release'
+      build-profile: 'release'
+      run-audit: true
       enable-cache: true
       upload-artifact: true
-      artifact-name: 'my-rust-app'
-      artifact-path: 'target/release/my-app'
+      artifact-name: my-crate
+      artifact-path: target/release/my-crate
+    secrets:
+      CRATES_IO_TOKEN: ${{ secrets.CRATES_IO_TOKEN }}
 ```
 
 ## Inputs
 
-| Name                | Description                                        | Default   | Required                            |
-|---------------------|----------------------------------------------------|-----------|-------------------------------------|
-| `rust-version`      | Rust version to use                                | `stable`  | No                                  |
-| `build-target`      | Cargo profile to use for building (debug, release) | `release` | No                                  |
-| `enable-cache`      | Enable caching of dependencies                     | `true`    | No                                  |
-| `publish-crates-io` | Publish package to crates.io                       | `false`   | No                                  |
-| `upload-artifact`   | Upload build artifact                              | `false`   | No                                  |
-| `artifact-name`     | Name of the artifact to upload                     | -         | Only if `upload-artifact` is `true` |
-| `artifact-path`     | Path to the artifact to upload                     | -         | Only if `upload-artifact` is `true` |
+| Name                | Description                                                  | Default   | Required |
+| ------------------- | ------------------------------------------------------------ | --------- | -------- |
+| `rust-version`      | Rust version to use                                          | `stable`  | No       |
+| `build-profile`     | Cargo profile to use for building (`debug`, `release`, etc.) | `release` | No       |
+| `run-audit`         | Run `cargo audit` for security vulnerabilities               | `true`    | No       |
+| `enable-cache`      | Enable caching of dependencies                               | `true`    | No       |
+| `upload-artifact`   | Upload a build artifact after building                       | `false`   | No       |
+| `artifact-name`     | Name of the artifact to upload                               | –         | No       |
+| `artifact-path`     | Path to the artifact to upload                               | –         | No       |
+| `publish-crates-io` | Publish the package to crates.io (only if build succeeds)    | `false`   | No       |
 
 ## Secrets
 
-| Name              | Description                       | Required                              |
-|-------------------|-----------------------------------|---------------------------------------|
-| `CRATES_IO_TOKEN` | Token for publishing to crates.io | Only if `publish-crates-io` is `true` |
+| Name              | Description                             | Required                              |
+| ----------------- | --------------------------------------- | ------------------------------------- |
+| `CRATES_IO_TOKEN` | crates.io API token for `cargo publish` | Only if `publish-crates-io` is `true` |
 
 ## Examples
 
@@ -56,19 +63,39 @@ jobs:
     uses: iExecBlockchainComputing/github-actions-workflows/.github/workflows/rust-build.yml@main
 ```
 
-### Build, Test, and Upload Artifact
+### Disable Security Audit
 
 ```yaml
 jobs:
   build-and-test:
+    uses: iExecBlockchainComputing/github-actions-workflows/.github/workflows/rust-build.yml@main
+    with:
+      run-audit: false
+```
+
+### Use Debug Profile
+
+```yaml
+jobs:
+  build-and-test:
+    uses: iExecBlockchainComputing/github-actions-workflows/.github/workflows/rust-build.yml@main
+    with:
+      build-profile: 'debug'
+```
+
+### Upload Artifact After Build
+
+```yaml
+jobs:
+  build-and-upload:
     uses: iExecBlockchainComputing/github-actions-workflows/.github/workflows/rust-build.yml@main
     with:
       upload-artifact: true
-      artifact-name: 'my-rust-app'
-      artifact-path: 'target/release/my-app'
+      artifact-name: my-crate
+      artifact-path: target/release/my-crate
 ```
 
-### Build, Test, and Publish to crates.io
+### Publish to crates.io (requires CRATES_IO_TOKEN)
 
 ```yaml
 jobs: