Add a composite action to handle toolchain, tools & cache in ci

Author: Alenar

.github/workflows/actions/build-upload-mithril-artifact/action.yml

@@ -5,25 +5,9 @@ inputs:
     description: Arguments to pass to 'cargo build'
     required: false
     default: ''
-  cache-version:
-    description: Version of the current cache
-    required: false
-    default: ''
 runs:
   using: "composite"
   steps:
-    - name: Install stable toolchain
-      uses: actions-rs/toolchain@v1
-      with:
-        profile: minimal
-        toolchain: stable
-        override: true
-
-    - name: Rust Cache
-      uses: Swatinem/rust-cache@v2
-      with:
-        key: ${{ runner.os }}-cache-v${{ inputs.cache-version }}
-        
     - name: Add commit short sha to Cargo.tomls version
       shell: bash
       run: |

.github/workflows/actions/toolchain-and-cache/action.yml

@@ -0,0 +1,31 @@
+name: toolchain-and-cache
+description: Install the stable cargo toolchain, the given cargo tools, and try to restore cache
+inputs:
+  cache-version:
+    description: Version of the current cache
+    required: false
+    default: ''
+  cargo-tools:
+    description: Space seperated list of cargo tools to install
+    required: false
+    default: ''
+runs:
+  using: "composite"
+  steps:
+    - name: Install stable toolchain
+      uses: actions-rs/toolchain@v1
+      with:
+        profile: minimal
+        toolchain: stable
+        override: true
+
+    - name: Rust Cache
+      uses: Swatinem/rust-cache@v2
+      with:
+        key: ${{ runner.os }}-cache-v${{ inputs.cache-version }}
+
+    - name: Install cargo tools
+      if: inputs.cargo-tools != ''
+      shell: bash
+      run: |
+        cargo install ${{ inputs.cargo-tools }} 2>/dev/null || true # Suppress the "binary `xyz` already exists in destination" error

.github/workflows/ci.yml

@@ -15,11 +15,14 @@ jobs:
       - name: Checkout sources
         uses: actions/checkout@v3
 
-      - name: Build Mithril workspace & publish artifacts
-        uses: ./.github/workflows/actions/build-upload-mithril-artifact
+      - name: Install stable toolchain and restore cache
+        uses: ./.github/workflows/actions/toolchain-and-cache
         with:
           cache-version: ${{ secrets.CACHE_VERSION }}
 
+      - name: Build Mithril workspace & publish artifacts
+        uses: ./.github/workflows/actions/build-upload-mithril-artifact
+
       - name: Publish End-to-end runner (${{ runner.os }}-${{ runner.arch }})
         uses: actions/upload-artifact@v3
         with:
@@ -44,11 +47,15 @@ jobs:
     steps:
       - name: Checkout sources
         uses: actions/checkout@v3
+
+      - name: Install stable toolchain and restore cache
+        uses: ./.github/workflows/actions/toolchain-and-cache
+        with:
+          cache-version: ${{ secrets.CACHE_VERSION }}
 
       - name: Build Mithril workspace & publish artifacts
         uses: ./.github/workflows/actions/build-upload-mithril-artifact
         with:
-          cache-version: ${{ secrets.CACHE_VERSION }}
           build-args: ${{ matrix.build-args }}
 
   test:
@@ -75,22 +82,11 @@ jobs:
       - name: Checkout sources
         uses: actions/checkout@v3
 
-      - name: Install stable toolchain
-        uses: actions-rs/toolchain@v1
-        with:
-          profile: minimal
-          toolchain: stable
-          override: true
-
-      - name: Rust Cache
-        uses: Swatinem/rust-cache@v2
+      - name: Install stable toolchain, tools, and restore cache
+        uses: ./.github/workflows/actions/toolchain-and-cache
         with:
-          key: ${{ runner.os }}-cache-v${{ secrets.CACHE_VERSION }}
-
-      - name: Install cargo tools
-        shell: bash
-        run: |
-          cargo install cargo2junit 2>/dev/null || true # Suppress the "binary `xyz` already exists in destination" error
+          cache-version: ${{ secrets.CACHE_VERSION }}
+          cargo-tools: cargo2junit
 
       - name: Run tests
         shell: bash
@@ -114,24 +110,11 @@ jobs:
       - name: Checkout sources
         uses: actions/checkout@v3
 
-      - name: Install stable toolchain
-        uses: actions-rs/toolchain@v1
-        with:
-          profile: minimal
-          toolchain: stable
-          components: clippy, rustfmt
-          override: true
-      
-      - name: Rust Cache
-        uses: Swatinem/rust-cache@v2
+      - name: Install stable toolchain, tools, and restore cache
+        uses: ./.github/workflows/actions/toolchain-and-cache
         with:
-          key: ${{ runner.os }}-cache-v${{ secrets.CACHE_VERSION }}
-
-      - name: Install cargo tools
-        if: steps.cargo-cache.outputs.cache-hit == false
-        shell: bash
-        run: |
-          cargo install cargo-sort 2>/dev/null || true # Suppress the "binary `xyz` already exists in destination" error
+          cache-version: ${{ secrets.CACHE_VERSION }}
+          cargo-tools: cargo-sort
 
       - name: Cargo check
         uses: actions-rs/cargo@v1

.github/workflows/docs.yml

@@ -12,17 +12,10 @@ jobs:
       - name: Checkout sources
         uses: actions/checkout@v3
 
-      - name: Install stable toolchain
-        uses: actions-rs/toolchain@v1
+      - name: Install stable toolchain and restore cache
+        uses: ./.github/workflows/actions/toolchain-and-cache
         with:
-          profile: minimal
-          toolchain: stable
-          override: true
-
-      - name: Rust Cache
-        uses: Swatinem/rust-cache@v2
-        with:
-          key: ${{ runner.os }}-cache-v${{ secrets.CACHE_VERSION }}
+          cache-version: ${{ secrets.CACHE_VERSION }}
 
       - name: Generate cargo doc
         uses: actions-rs/cargo@v1