From 8ed22491e2506036c35bcd8e420ed539bf0dfc1c Mon Sep 17 00:00:00 2001
From: Martin Indra <martin.indra@mgn.cz>
Date: Tue, 8 Aug 2023 17:50:52 +0200
Subject: [PATCH] CI: Improve GitHub actions (#669)

Moves Rust & CI setup to an action so it can be reused. Splits
previously sequential build -> clippy -> test steps to individual jobs
so they can be executed in parallel.

The changes improve organization of the CI pipeline and reduce execution
time.

Relates to #48.
---
 .github/actions/rust/action.yml          | 47 ++++++++++++++
 .github/workflows/{rust.yml => test.yml} | 79 +++++++++++-------------
 2 files changed, 82 insertions(+), 44 deletions(-)
 create mode 100644 .github/actions/rust/action.yml
 rename .github/workflows/{rust.yml => test.yml} (60%)

diff --git a/.github/actions/rust/action.yml b/.github/actions/rust/action.yml
new file mode 100644
index 00000000..2e0ed7f7
--- /dev/null
+++ b/.github/actions/rust/action.yml
@@ -0,0 +1,47 @@
+name: Rust Setup
+
+inputs:
+  name:
+    required: true
+    type: string
+  components:
+    required: false
+    type: string
+
+runs:
+  using: 'composite'
+  steps:
+    - shell: bash
+      run: |
+        sudo apt-get update
+        sudo apt-get install --no-install-recommends -y libasound2-dev libudev-dev
+
+    - shell: bash
+      run: "git lfs ls-files -l | cut -d' ' -f1 | sort > .lfs-assets-id"
+
+    - uses: actions/cache@v3
+      with:
+        path: .git/lfs
+        key: rust-lfs-${{ inputs.name }}-${{ hashFiles('.lfs-assets-id') }}-v1
+
+    - shell: bash
+      run: git lfs pull
+
+    - uses: dtolnay/rust-toolchain@stable
+      id: rust-toolchain
+      with:
+        components: ${{ inputs.components }}
+
+    - shell: bash
+      run: rustc --version && cargo --version
+
+    - uses: actions/cache@v3
+      id: rust-cache
+      with:
+        path: |
+          ~/.cargo/bin/
+          ~/.cargo/registry/index/
+          ~/.cargo/registry/cache/
+          ~/.cargo/git/db/
+          target/
+        key: rust-cargo-${{ inputs.name }}-${{ steps.rust-toolchain.outputs.cachekey }}-${{ hashFiles('**/Cargo.lock') }}-v1
diff --git a/.github/workflows/rust.yml b/.github/workflows/test.yml
similarity index 60%
rename from .github/workflows/rust.yml
rename to .github/workflows/test.yml
index 364be55d..ea054985 100644
--- a/.github/workflows/rust.yml
+++ b/.github/workflows/test.yml
@@ -1,4 +1,4 @@
-name: Rust
+name: Test & Check
 
 on:
   push:
@@ -21,59 +21,50 @@ env:
 
 jobs:
   build:
-    name: Build & Test
+    name: Build
     if: github.event.pull_request.draft == false
-    runs-on: ${{ matrix.os }}
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [ubuntu-latest]
+    runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-
-      - name: Create LFS file list
-        run: git lfs ls-files -l | cut -d' ' -f1 | sort > .lfs-assets-id
-      - name: Restore LFS cache
-        uses: actions/cache@v3
+      - name: Checkout
+        uses: actions/checkout@v3
+      - uses: ./.github/actions/rust
+        name: Setup
         with:
-          path: .git/lfs
-          key: lfs-${{ runner.os }}-${{ hashFiles('.lfs-assets-id') }}-v1
-      - name: Git LFS Pull
-        run: git lfs pull
+          name: test-build
+      - name: Build
+        run: cargo build --verbose --all-targets --all-features --locked
 
-      - uses: dtolnay/rust-toolchain@stable
+  clippy:
+    name: Clippy
+    if: github.event.pull_request.draft == false
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - uses: ./.github/actions/rust
+        name: Setup
         with:
+          name: clippy
           components: clippy
-
-      - name: Rust Cache
-        uses: actions/cache@v3
-        id: rust-cache
-        with:
-          path:  |
-            ~/.cargo/bin/
-            ~/.cargo/registry/index/
-            ~/.cargo/registry/cache/
-            ~/.cargo/git/db/
-            target/
-          key: tests-${{ runner.os }}-${{ hashFiles('**/Cargo.lock') }}
-          restore-keys: |
-            tests-${{ runner.os }}-
-
-      - name: Install Linux Dependencies
-        if: ${{ matrix.os == 'ubuntu-latest' }}
-        run: |
-          sudo apt-get update
-          sudo apt-get install --no-install-recommends -y libasound2-dev libudev-dev
-      - run: rustc --version && cargo --version && cargo clippy --version
-      - name: Build
-        run: cargo build --verbose --all-targets --all-features --locked
       - name: Clippy
         run: cargo clippy --all --all-targets --all-features --workspace -- --deny warnings
+
+  test:
+    name: Test
+    if: github.event.pull_request.draft == false
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - uses: ./.github/actions/rust
+        name: Setup
+        with:
+          name: test
       - name: Test
         run: cargo test --verbose --all-features --workspace
 
   format:
-    name: Test Formatting
+    name: Formatting
     if: github.event.pull_request.draft == false
     runs-on: ubuntu-latest
     steps:
@@ -85,7 +76,7 @@ jobs:
       - run: cargo +nightly fmt --all -- --check
 
   udeps:
-    name: Check Unused Dependencies
+    name: Unused Deps
     if: github.event.pull_request.draft == false
     runs-on: ubuntu-latest
     steps:
@@ -110,7 +101,7 @@ jobs:
         run: cargo udeps
 
   comments:
-    name: Check Code Comments
+    name: Code Comments
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3