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

BREAKING CHANGE: enforce use of 'release' as build-target and remove artifact upload step.

Author: nabil-Tounarti

.github/workflows/rust-build.yml

@@ -7,9 +7,9 @@ on:
         description: 'Rust version to use'
         default: 'stable'
         type: string
-      build-target:
-        description: 'Cargo profile to use for building (debug, release)'
-        default: 'release'
+      working-directory:
+        description: 'The directory to run jobs from'
+        default: '.'
         type: string
       enable-cache:
         description: 'Enable caching of dependencies'
@@ -19,85 +19,62 @@ on:
         description: 'Publish package to crates.io'
         default: false
         type: boolean
-      upload-artifact:
-        description: 'Upload build artifact'
-        default: false
-        type: boolean
-      artifact-name:
-        description: 'Name of the artifact to upload'
-        type: string
-        required: false
-      artifact-path:
-        description: 'Path to the artifact to upload'
-        type: string
-        required: false
     secrets:
-      CRATES_IO_TOKEN:
+      CARGO_REGISTRY_TOKEN:
         required: false
 
+env:
+  CARGO_TERM_COLOR: always
+  CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
+  
 jobs:
-  build:
+  build_and_publish:
     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@master
         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/bin/
             ~/.cargo/registry
             ~/.cargo/git
             target
-          key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
+          key: ${{ runner.os }}-cargo-release-${{ hashFiles('**/Cargo.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-cargo-release-
 
-      - name: Build
-        run: cargo build --profile ${{ inputs.build-target }}
-
-      - name: Run tests
-        run: cargo test --profile ${{ inputs.build-target }}
+      - name: Check formatting
+        working-directory: ${{ inputs.working-directory }}
+        run: cargo fmt --all -- --check
 
-      - name: Set build success output
-        id: set-output
-        run: echo "build_success=true" >> $GITHUB_OUTPUT
-
-      - name: Upload artifact
-        if: ${{ inputs.upload-artifact }}
-        uses: actions/upload-artifact@v4
-        with:
-          name: ${{ inputs.artifact-name }}
-          path: ${{ inputs.artifact-path }}
+      - name: Run linter (Clippy)
+        working-directory: ${{ inputs.working-directory }}
+        run: cargo clippy --all-targets -- -D warnings
 
-  publish:
-    needs: build
-    if: ${{ inputs.publish-crates-io && needs.build.outputs.build_success == 'true' }}
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
-
-      - name: Install Rust toolchain
-        uses: actions-rs/toolchain@v1
-        with:
-          profile: minimal
-          toolchain: ${{ inputs.rust-version }}
-          override: true
+      - name: Build
+        working-directory: ${{ inputs.working-directory }}
+        run: cargo build --release
 
-      - name: Login to crates.io
-        run: cargo login ${{ secrets.CRATES_IO_TOKEN }}
+      - name: Run tests
+        working-directory: ${{ inputs.working-directory }}
+        run: cargo test --release
 
-      - name: Package for crates.io
+      - name: Validate package
+        if: ${{ inputs.publish-crates-io }}
+        working-directory: ${{ inputs.working-directory }}
         run: cargo package
 
       - name: Publish to crates.io
-        run: cargo publish
+        if: ${{ inputs.publish-crates-io }}
+        working-directory: ${{ inputs.working-directory }}
+        run: cargo publish

rust-build/README.md

@@ -1,13 +1,15 @@
 # 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 publishing Rust packages, with optional dependency caching and working directory support.
 
 ## Features
 
 - Build and test Rust packages
+- Lint code using `clippy`
+- Check formatting with `cargo fmt`
 - Cache dependencies for faster builds
-- Publish packages to crates.io
-- Upload build artifacts
+- Set a working directory (for monorepos or nested crates)
+- Publish to crates.io
 
 ## Usage
 
@@ -21,30 +23,29 @@ jobs:
     uses: iExecBlockchainComputing/github-actions-workflows/.github/workflows/rust-build.yml@main
     with:
       rust-version: 'stable'
-      build-target: 'release'
+      working-directory: './my-crate'
       enable-cache: true
-      upload-artifact: true
-      artifact-name: 'my-rust-app'
-      artifact-path: 'target/release/my-app'
+      publish-crates-io: false
+    secrets:
+      CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_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       |
+| `working-directory` | The directory to run jobs from                            | `.`      | No       |
+| `enable-cache`      | Enable caching of dependencies                            | `true`   | No       |
+| `publish-crates-io` | Publish the package to crates.io (only if build succeeds) | `false`  | No       |
+
+Note: All builds use the release profile by default. There is no build-target input anymore
 
 ## Secrets
 
-| Name              | Description                       | Required                              |
-|-------------------|-----------------------------------|---------------------------------------|
-| `CRATES_IO_TOKEN` | Token for publishing to crates.io | Only if `publish-crates-io` is `true` |
+| Name                   | Description                             | Required                              |
+| ---------------------- | --------------------------------------- | ------------------------------------- |
+| `CARGO_REGISTRY_TOKEN` | crates.io API token for `cargo publish` | Only if `publish-crates-io` is `true` |
 
 ## Examples
 
@@ -56,19 +57,17 @@ jobs:
     uses: iExecBlockchainComputing/github-actions-workflows/.github/workflows/rust-build.yml@main
 ```
 
-### Build, Test, and Upload Artifact
+### Specify a Working Directory
 
 ```yaml
 jobs:
   build-and-test:
     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'
+      working-directory: './my-crate'
 ```
 
-### Build, Test, and Publish to crates.io
+### Publish to crates.io (requires CARGO_REGISTRY_TOKEN)
 
 ```yaml
 jobs:
@@ -77,5 +76,5 @@ jobs:
     with:
       publish-crates-io: true
     secrets:
-      CRATES_IO_TOKEN: ${{ secrets.CRATES_IO_TOKEN }}
+      CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
 ```