From f10c73f4fa92f3a35665cdb060063f0f3dcf2bd8 Mon Sep 17 00:00:00 2001
From: Wilfried Chauveau <wilfried.chauveau@ithinuel.me>
Date: Fri, 12 Aug 2022 11:55:54 +0100
Subject: [PATCH] Add meaningful names to steps and remove quasi-repetition

The workflow only shows "Runs action-rs/cargo@v1" which does not tell us
much about what's actually being done.
The list and clean up done after each build varies by only the debug/release
part of the path that is repeated several times (2).

This commit gives each step a more meaningful name and simplify the list &
cleanup step with a generic one liner that can be copy/pasted without
modification.
---
 .github/workflows/build_and_test.yml | 52 ++++++++++++++++------------
 1 file changed, 30 insertions(+), 22 deletions(-)

diff --git a/.github/workflows/build_and_test.yml b/.github/workflows/build_and_test.yml
index 43a0fcd..b2a75ab 100644
--- a/.github/workflows/build_and_test.yml
+++ b/.github/workflows/build_and_test.yml
@@ -12,43 +12,51 @@ jobs:
           target: thumbv6m-none-eabi
           override: true
           profile: minimal
-      - uses: actions-rs/cargo@v1
+      - name: "Build workspace (debug)"
+        uses: actions-rs/cargo@v1
         with:
           command: build
           args: --workspace
-      - uses: actions-rs/cargo@v1
+      - name: "Build workspace and examples (debug)"
+        uses: actions-rs/cargo@v1
         with:
           command: build
           args: --workspace --examples
-      - run: echo "Debug examples built:" && ls target/thumbv6m-none-eabi/debug/examples/ |grep -v '-' |grep -v '\.d'
-      - run: rm target/thumbv6m-none-eabi/debug/examples/ -rf
-      - uses: actions-rs/cargo@v1
+      - name: "List built examples and clean"
+        run: rm -vrf target/thumbv6m-none-eabi/*/examples/* | sed -e "s/removed '\(.*\)'/\1/" | xargs -l basename | grep -Ev '(-|\.d)'
+      - name: "Build workspace and examples (debug, features=eh1_0_alpha)"
+        uses: actions-rs/cargo@v1
         with:
           command: build
           args: --workspace --examples --features eh1_0_alpha
-      - run: echo "Debug eh1_0 examples built:" && ls target/thumbv6m-none-eabi/debug/examples/ |grep -v '-' |grep -v '\.d'
-      - run: rm target/thumbv6m-none-eabi/debug/examples/ -rf
-      - uses: actions-rs/cargo@v1
+      - name: "List built examples and clean"
+        run: rm -vrf target/thumbv6m-none-eabi/*/examples/* | sed -e "s/removed '\(.*\)'/\1/" | xargs -l basename | grep -Ev '(-|\.d)'
+      - name: "Build workspace and examples (release)"
+        uses: actions-rs/cargo@v1
         with:
           command: build
           args: --release --workspace --examples
-      - run: echo "Release examples built:" && ls target/thumbv6m-none-eabi/release/examples/ |grep -v '-' |grep -v '\.d'
-      - run: rm target/thumbv6m-none-eabi/release/examples/ -rf
-      - uses: actions-rs/cargo@v1
+      - name: "List built examples and clean"
+        run: rm -vrf target/thumbv6m-none-eabi/*/examples/* | sed -e "s/removed '\(.*\)'/\1/" | xargs -l basename | grep -Ev '(-|\.d)'
+      - name: "Build workspace and examples (release, features=eh1_0_alpha)"
+        uses: actions-rs/cargo@v1
         with:
           command: build
           args: --release --workspace --examples --features eh1_0_alpha
-      - run: echo "Release eh1_0 examples built:" && ls target/thumbv6m-none-eabi/release/examples/ |grep -v '-' |grep -v '\.d'
-      - run: rm target/thumbv6m-none-eabi/release/examples/ -rf
-      - uses: actions-rs/cargo@v1
-        with:
-          command: test
-          args: --doc --target x86_64-unknown-linux-gnu
-      - uses: actions-rs/cargo@v1
-        with:
-          command: test
-          args: --doc --target x86_64-unknown-linux-gnu --features chrono
-      - uses: actions-rs/cargo@v1
+      - name: "List built examples and clean"
+        run: rm -vrf target/thumbv6m-none-eabi/*/examples/* | sed -e "s/removed '\(.*\)'/\1/" | xargs -l basename | grep -Ev '(-|\.d)'
+      - name: "Test"
+        uses: actions-rs/cargo@v1
         with:
           command: test
           args: --tests --target x86_64-unknown-linux-gnu
+      - name: "Test docs"
+        uses: actions-rs/cargo@v1
+        with:
+          command: test
+          args: --doc --target x86_64-unknown-linux-gnu
+      - name: "Test docs (features=chrono)"
+        uses: actions-rs/cargo@v1
+        with:
+          command: test
+          args: --doc --target x86_64-unknown-linux-gnu --features chrono