feat: add support for artifact upload and crates.io publishing in Rust workflow

Author: nabil-Tounarti

.github/workflows/rust-build.yml

@@ -19,13 +19,32 @@ on:
         description: 'Enable caching of dependencies'
         default: true
         type: boolean
+      publish-crates-io:
+        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:
+        required: false
 
 env:
   CARGO_TERM_COLOR: always
 
 jobs:
-  build-and-test:
-    name: Build & Test
+  build:
+    name: build
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repository
@@ -70,3 +89,30 @@ jobs:
 
       - name: Run tests
         run: cargo test --profile ${{ inputs.build-profile }}
+
+      - name: Upload artifact
+        if: ${{ inputs.upload-artifact }}
+        uses: actions/upload-artifact@v4
+        with:
+          name: ${{ inputs.artifact-name }}
+          path: ${{ inputs.artifact-path }}
+
+  publish:
+      needs: build
+      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: dtolnay/rust-toolchain@stable
+          with:
+            toolchain: ${{ inputs.rust-version }}
+            components: cargo
+
+        - name: Validate package
+          run: cargo package --allow-dirty
+
+        - name: Publish to crates.io
+          run: cargo publish --token ${{ secrets.CRATES_IO_TOKEN }}

rust-build/README.md

@@ -1,14 +1,16 @@
-# Rust Build and Test Workflow
+# Rust Build Workflow
 
-A reusable GitHub Actions workflow for building, linting, testing, and auditing 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
+- Lint code using `clippy`
+- Check formatting with `cargo fmt`
+- Run security audits with `cargo audit`
 - Cache dependencies for faster builds
+- Upload build artifacts
+- Publish to crates.io
 
 ## Usage
 
@@ -25,16 +27,31 @@ jobs:
       build-profile: '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 }}
 ```
 
 ## Inputs
 
-| Name            | Description                                    | Default   | Required |
-| --------------- | ---------------------------------------------- | --------- | -------- |
-| `rust-version`  | Rust version to use                            | `stable`  | No       |
-| `build-profile` | Cargo profile to use (debug, release)          | `release` | No       |
-| `run-audit`     | Run `cargo audit` for security vulnerabilities | `true`    | No       |
-| `enable-cache`  | Enable caching of dependencies                 | `true`    | No       |
+| 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` | crates.io API token for `cargo publish` | Only if `publish-crates-io` is `true` |
 
 ## Examples
 
@@ -60,9 +77,32 @@ jobs:
 
 ```yaml
 jobs:
-  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-test:
+    uses: iExecBlockchainComputing/github-actions-workflows/.github/workflows/rust-build.yml@main
+    with:
+      upload-artifact: true
+      artifact-name: my-crate
+      artifact-path: target/release/my-crate
+```
+
+### Publish to crates.io (requires CRATES_IO_TOKEN)
+
+```yaml
+jobs:
+  build-and-test:
+    uses: iExecBlockchainComputing/github-actions-workflows/.github/workflows/rust-build.yml@main
+    with:
+      publish-crates-io: true
+    secrets:
+      CRATES_IO_TOKEN: ${{ secrets.CRATES_IO_TOKEN }}
 ```