ci: improve `build.yml`

.github/workflows/build.yml

@@ -1,107 +1,128 @@
+# Copyright (c) 2023 Hamothy
+# Copyright (c) 2015 Andrew Gallant
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+
 name: build
 
 on:
+  workflow_dispatch:
   push:
-    branches:
+    paths:
-      - '**'
+      - "src/**"
+      - "Cargo.toml"
+      - "Cargo.lock"
   pull_request:
+    paths:
+      - "src/**"
+      - "Cargo.toml"
+      - "Cargo.lock"
+
+env:
+  BINARY: mdbook-template
 
 jobs:
-  install-cross:
+  compile:
-    runs-on: ubuntu-latest
+    env:
-    steps:
+      CARGO: cargo
-      - uses: actions/checkout@v1
+      TARGET_FLAGS:
-        with:
+      TARGET_DIR: ./target
-          fetch-depth: 50
+      RUST_BACKTRACE: 1
-      - uses: XAMPPRocky/get-github-release@v1
+    runs-on: ${{ matrix.os }}
-        id: cross
-        with:
-          owner: rust-embedded
-          repo: cross
-          matches: ${{ matrix.platform }}
-          token: ${{ secrets.GITHUB_TOKEN }}
-      - uses: actions/upload-artifact@v1
-        with:
-          name: cross-${{ matrix.platform }}
-          path: ${{ steps.cross.outputs.install_path }}
     strategy:
+      fail-fast: false
       matrix:
-        platform: [ linux-musl, apple-darwin ]
+        build:
-
+          - stable
-  windows:
+          - nightly-gnu
-    runs-on: windows-latest
+          - nightly-musl
-    needs: install-cross
+          - nightly-32
+          - nightly-arm
+          - macos
+          - win-msvc
+          - win-gnu
+        include:
+          - build: stable
+            os: ubuntu-22.04
+            rust: stable
+          - build: nightly-gnu
+            os: ubuntu-22.04
+            rust: nightly
+            target: x86_64-unknown-linux-gnu
+          - build: nightly-musl
+            os: ubuntu-22.04
+            rust: nightly
+            target: x86_64-unknown-linux-musl
+          - build: nightly-32
+            os: ubuntu-22.04
+            rust: nightly
+            target: i686-unknown-linux-gnu
+          - build: nightly-arm
+            os: ubuntu-22.04
+            rust: nightly
+            target: arm-unknown-linux-gnueabihf
+          - build: macos
+            os: macos-12
+            rust: nightly
+          - build: win-msvc
+            os: windows-2022
+            rust: nightly
+          - build: win-gnu
+            os: windows-2022
+            rust: nightly-x86_64-gnu
     steps:
-      - uses: actions/checkout@v2
+      - name: Checkout repository
-        with:
+        uses: actions/checkout@v3
-          fetch-depth: 50
-      - run: .github/scripts/set_rust_version.bash ${{ matrix.channel }} ${{ matrix.target }}
-        shell: bash
-      - run: .github/scripts/build.bash cargo ${{ matrix.target }}
-        shell: bash
-      - run: .github/scripts/test.bash cargo ${{ matrix.target }}
-        shell: bash
 
-    strategy:
+      - name: Install packages (Ubuntu)
-      matrix:
+        if: matrix.os == 'ubuntu-22.04'
-        channel: [ stable, beta ]
+        shell: bash
-        target:
+        run: sudo apt-get update && sudo apt-get install -y --no-install-recommends musl-tools
-          - x86_64-pc-windows-gnu
-          - x86_64-pc-windows-msvc
 
-  macos:
+      - name: Install Rust
-    runs-on: macos-latest
+        uses: dtolnay/rust-toolchain@master
-    needs: install-cross
-    steps:
-      - uses: actions/checkout@v2
         with:
-          fetch-depth: 50
+          toolchain: ${{ matrix.rust }}
 
-      - uses: actions/download-artifact@v1
+      - name: Cache Rust
-        with:
+        uses: Swatinem/rust-cache@v2
-          name: cross-apple-darwin
-          path: /usr/local/bin/
 
-      - run: chmod +x /usr/local/bin/cross
+      - name: Use Cross
+        if: matrix.target != ''
+        run: |
+          cargo install cross
+          echo "CARGO=cross" >> $GITHUB_ENV
+          echo "TARGET_FLAGS=--target ${{ matrix.target }}" >> $GITHUB_ENV
+          echo "TARGET_DIR=./target/${{ matrix.target }}" >> $GITHUB_ENV
 
-      - run: .github/scripts/set_rust_version.bash ${{ matrix.channel }} ${{ matrix.target }}
+      - name: Show command used for Cargo
-      - run: .github/scripts/build.bash cross ${{ matrix.target }}
+        run: |
-      - run: .github/scripts/test.bash cross ${{ matrix.target }}
+          echo "cargo command is: ${{ env.CARGO }}"
-        if: matrix.target == 'x86_64-apple-darwin'
+          echo "target flag is: ${{ env.TARGET_FLAGS }}"
 
-    strategy:
+      - name: Compile
-      matrix:
+        run: ${{ env.CARGO }} build --verbose ${{ env.TARGET_FLAGS }}
-        channel: [ stable, beta ]
-        target:
-          - x86_64-apple-darwin
 
-  linux:
+      - name: Test
-    runs-on: ubuntu-latest
+        run: ${{ env.CARGO }} test --verbose ${{ env.TARGET_FLAGS }}
-    needs: install-cross
-    steps:
-      - uses: actions/checkout@v2
-        with:
-          fetch-depth: 50
 
-      - name: Download Cross
+      - name: Retrieve Name of Binary
-        uses: actions/download-artifact@v1
+        id: upload-artifact
-        with:
+        shell: bash
-          name: cross-linux-musl
+        run: |
-          path: /tmp/
+          if [ "${{ matrix.os }}" == "windows-2022" ]; then
-      - run: chmod +x /tmp/cross
+            echo "name=${{ env.TARGET_DIR }}/debug/${{ env.BINARY }}.exe" >> $GITHUB_OUTPUT
-      - run: .github/scripts/set_rust_version.bash ${{ matrix.channel }} ${{ matrix.target }}
+          else
-      - run: .github/scripts/build.bash /tmp/cross ${{ matrix.target }}
+            echo "name=${{ env.TARGET_DIR}}/debug/${{ env.BINARY }}" >> $GITHUB_OUTPUT
-      - run: .github/scripts/test.bash /tmp/cross ${{ matrix.target }}
+          fi
-        if: |
-          !contains(matrix.target, 'android') &&
-          !contains(matrix.target, 'bsd') &&
-          !contains(matrix.target, 'solaris') &&
-          matrix.target != 'armv5te-unknown-linux-musleabi' &&
-          matrix.target != 'sparc64-unknown-linux-gnu'
 
-    strategy:
+      - name: Upload Binary
-      matrix:
+        uses: actions/upload-artifact@v3
-        channel: [ stable, beta ]
+        with:
-        target:
+          name: ${{ env.BINARY }}-${{ matrix.build }}
-          - x86_64-unknown-linux-gnu
+          path: ${{ steps.upload-artifact.outputs.name }}
-          - x86_64-unknown-linux-musl