chore(ci): rename build-profile to build-target and update cache path in Rust workflow

Author: nabil-Tounarti

.github/workflows/rust-build.yml

@@ -7,7 +7,7 @@ on:
         description: 'Rust version to use'
         default: 'stable'
         type: string
-      build-profile:
+      build-target:
         description: 'Cargo profile to use for building (debug, release)'
         default: 'release'
         type: string
@@ -36,7 +36,7 @@ on:
         type: string
         required: false
     secrets:
-      CRATES_IO_TOKEN:
+      CARGO_REGISTRY_TOKEN:
         required: false
 
 env:
@@ -61,13 +61,12 @@ jobs:
         with:
           path: |
             ~/.cargo/bin/
-            ~/.cargo/registry/index/
-            ~/.cargo/registry/cache/
+            ~/.cargo/registry
             ~/.cargo/git
             target
-          key: ${{ runner.os }}-cargo-${{ inputs.build-profile }}-${{ hashFiles('**/Cargo.lock') }}
+          key: ${{ runner.os }}-cargo-${{ inputs.build-target }}-${{ hashFiles('**/Cargo.lock') }}
           restore-keys: |
-            ${{ runner.os }}-cargo-${{ inputs.build-profile }}-
+            ${{ runner.os }}-cargo-${{ inputs.build-target }}-
 
       - name: Check formatting
         run: cargo fmt --all -- --check
@@ -84,10 +83,10 @@ jobs:
         run: cargo audit
 
       - name: Build
-        run: cargo build --profile ${{ inputs.build-profile }}
+        run: cargo build --profile ${{ inputs.build-target }}
 
       - name: Run tests
-        run: cargo test --profile ${{ inputs.build-profile }}
+        run: cargo test --profile ${{ inputs.build-target }}
 
       - name: Upload artifact
         if: ${{ inputs.upload-artifact }}
@@ -111,7 +110,7 @@ jobs:
           components: cargo
 
       - name: Validate package
-        run: cargo package --allow-dirty
+        run: cargo package
 
       - name: Publish to crates.io
-        run: cargo publish --token ${{ secrets.CRATES_IO_TOKEN }}
+        run: cargo publish --token ${{ secrets.CARGO_REGISTRY_TOKEN }}

rust-build/README.md

@@ -24,22 +24,22 @@ jobs:
     uses: iExecBlockchainComputing/github-actions-workflows/.github/workflows/rust-build.yml@main
     with:
       rust-version: 'stable'
-      build-profile: 'release'
+      build-target: 'release'
       run-audit: true
       enable-cache: true
       upload-artifact: true
       artifact-name: my-crate
       artifact-path: target/release/my-crate
     secrets:
-      CRATES_IO_TOKEN: ${{ secrets.CRATES_IO_TOKEN }}
+      CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
 ```
 
 ## Inputs
 
 | 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       |
+| `build-target`      | 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       |
@@ -49,9 +49,9 @@ jobs:
 
 ## Secrets
 
-| Name              | Description                             | Required                              |
-| ----------------- | --------------------------------------- | ------------------------------------- |
-| `CRATES_IO_TOKEN` | crates.io API token for `cargo publish` | 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
 
@@ -73,14 +73,14 @@ jobs:
       run-audit: false
 ```
 
-### Use Debug Profile
+### Use Debug Target
 
 ```yaml
 jobs:
   build-and-test:
     uses: iExecBlockchainComputing/github-actions-workflows/.github/workflows/rust-build.yml@main
     with:
-      build-profile: 'debug'
+      build-target: 'debug'
 ```
 
 ### Upload Artifact After Build
@@ -95,7 +95,7 @@ jobs:
       artifact-path: target/release/my-crate
 ```
 
-### Publish to crates.io (requires CRATES_IO_TOKEN)
+### Publish to crates.io (requires CARGO_REGISTRY_TOKEN)
 
 ```yaml
 jobs:
@@ -104,5 +104,5 @@ jobs:
     with:
       publish-crates-io: true
     secrets:
-      CRATES_IO_TOKEN: ${{ secrets.CRATES_IO_TOKEN }}
+      CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
 ```