Merge #580

580: more ci actions r=Emilgardis a=burrbull



Co-authored-by: Andrey Zgarbul <zgarbul.andrey@gmail.com>

Author: bors[bot]

.github/bors.toml

@@ -2,6 +2,7 @@ block_labels = ["needs-decision", "S-waiting-on-team"]
 delete_merged_branches = true
 required_approvals = 1
 status = [
+  "Rustfmt",
   "CI",
 ]
 timeout_sec = 14400

.github/workflows/changelog.yml

@@ -9,7 +9,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout sources
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Changelog updated
         uses: Zomzog/changelog-checker@v1.2.0

.github/workflows/ci.yml

@@ -9,28 +9,73 @@ jobs:
   ci:
     name: CI
     runs-on: ubuntu-latest
-    needs: [ci-linux]
-    steps: 
+    needs: [check, ci-linux, ci-clippy, ci-serde]
+    steps:
       - name: Done
         run: exit 0
+
+  check:
+    name: Cargo check
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        TARGET: [x86_64-unknown-linux-gnu, x86_64-apple-darwin, x86_64-pc-windows-msvc]
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: stable
+          override: true
+          target: ${{ matrix.TARGET }}
+
+      - name: Cache Dependencies
+        uses: Swatinem/rust-cache@v1
+        with:
+          key: ${{ matrix.TARGET }}
+
+      - uses: actions-rs/cargo@v1
+        with:
+          command: check
+          args: --target ${{ matrix.TARGET }}
+
+  prebuild:
+    name: Prebuild
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        rust: [stable, nightly, 1.46.0]
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: ${{ matrix.rust }}
+          override: true
+
+      - name: Cache
+        uses: Swatinem/rust-cache@v1
+        with:
+          sharedKey: prebuilded-${{ matrix.rust }}
+
+      - name: Self install
+        run: |
+          cargo install svd2rust --path .
+
   ci-linux:
     runs-on: ubuntu-latest
+    needs: [check, prebuild]
     strategy:
-      fail-fast: false
       matrix:
         # All generated code should be running on stable now
         rust: [stable]
 
         # All vendor files we want to test on stable
-        vendor: [rustfmt, Atmel, Freescale, Fujitsu, Holtek, Microchip, Nordic, Nuvoton, NXP, RISC-V, SiliconLabs, Spansion, STMicro, Toshiba]
-
-        # The default target we're compiling on and for
-        TARGET: [x86_64-unknown-linux-gnu]
-
-        # Temporary hack as long as we use the current CI script
-        TRAVIS_OS_NAME: [linux]
-
-        FEATURES: [""]
+        vendor: [Atmel, Freescale, Fujitsu, Holtek, Microchip, Nordic, Nuvoton, NXP, RISC-V, SiliconLabs, Spansion, STMicro, Toshiba]
 
         # Options are all, none, strict and const
         options: [all, none]
@@ -51,68 +96,103 @@ jobs:
           # Test MSRV
           - rust: 1.46.0
             vendor: Nordic
-            TARGET: x86_64-unknown-linux-gnu
-            TRAVIS_OS_NAME: linux
 
           # Use nightly for architectures which don't support stable
           - rust: nightly
-            experimental: true
             vendor: OTHER
-            TARGET: x86_64-unknown-linux-gnu
-            TRAVIS_OS_NAME: linux
 
-            # Use nightly for architectures which don't support stable
+          # Use nightly for architectures which don't support stable
           - rust: nightly
-            experimental: true
             vendor: Espressif
-            TARGET: x86_64-unknown-linux-gnu
-            TRAVIS_OS_NAME: linux
-
-          # OSX
-          - rust: stable
-            TARGET: x86_64-apple-darwin
-            TRAVIS_OS_NAME: osx
-
-          # Windows
-          - rust: stable
-            TARGET: x86_64-pc-windows-msvc
-            TRAVIS_OS_NAME: windows
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
+
       - uses: actions-rs/toolchain@v1
         with:
           profile: minimal
           toolchain: ${{ matrix.rust }}
-          target: ${{ matrix.TARGET }}
           override: true
-          components: rustfmt
+
+      - name: Cache
+        uses: Swatinem/rust-cache@v1
+        with:
+          sharedKey: prebuilded-${{ matrix.rust }}
+
       - name: Run CI script for `${{ matrix.vendor }}` under rust `${{ matrix.rust }}` with options=`${{ matrix.options }}`
         env:
-          TARGET: ${{ matrix.TARGET }}
           VENDOR: ${{ matrix.vendor }}
-          FEATURES: ${{ matrix.FEATURES }}
-          OPTIONS: ${{ matrix.options }} 
-          TRAVIS_OS_NAME: ${{ matrix.TRAVIS_OS_NAME }}
+          OPTIONS: ${{ matrix.options }}
+          COMMAND: check
         run: bash ci/script.sh
+
+  ci-clippy:
+    runs-on: ubuntu-latest
+    needs: [check, prebuild]
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: stable
+          override: true
+
+      - name: Cache
+        uses: Swatinem/rust-cache@v1
+        with:
+          sharedKey: prebuilded-stable
+
+      - name: Run CI script
+        env:
+          VENDOR: RISC-V
+          OPTIONS: all
+          COMMAND: clippy
+        run: bash ci/script.sh
+
   ci-serde:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
+
       - uses: actions-rs/toolchain@v1
         with:
           profile: minimal
           toolchain: stable
           override: true
-          components: rustfmt
-      - name: Install svdtools
-        uses: actions-rs/install@v0.1
+
+      - name: Cache
+        uses: Swatinem/rust-cache@v1
         with:
-          crate: svdtools
-          version: 0.2.0
-          use-tool-cache: true
+          key: svdtools-0.2.1
+
+      - name: Install svdtools
+        run: |
+          cargo install svdtools --version 0.2.1 --target-dir target
+
       - name: Run CI script
         run: |
           wget https://stm32-rs.github.io/stm32-rs/stm32f411.svd.patched
           svdtools convert --input-format xml stm32f411.svd.patched stm32f411.yaml
           cargo run --release -- -i stm32f411.yaml
+
+  fmt:
+    name: Rustfmt
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: stable
+          override: true
+          components: rustfmt
+
+      - name: Cache Dependencies
+        uses: Swatinem/rust-cache@v1
+
+      - uses: actions-rs/cargo@v1
+        with:
+          command: fmt
+          args: --all -- --check

.github/workflows/clippy.yml

@@ -5,13 +5,18 @@ jobs:
   clippy_check:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
+
       - uses: actions-rs/toolchain@v1
         with:
           profile: minimal
           toolchain: stable
           override: true
           components: clippy
+
+      - name: Cache Dependencies
+        uses: Swatinem/rust-cache@v1
+
       - uses: actions-rs/clippy-check@v1
         with:
           token: ${{ secrets.GITHUB_TOKEN }}

CHANGELOG.md

@@ -7,6 +7,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+- GHA: rust dependency caching
 - remove unnedded fields clone
 - Use reexport instead of type aliases in `derive_from_base`
 

ci/install.sh

@@ -8,67 +8,36 @@ test_svd() {
     )
 
     # NOTE we care about errors in svd2rust, but not about errors / warnings in rustfmt
-    local cwd=$(pwd)
     pushd $td
-    RUST_BACKTRACE=1 $cwd/target/$TARGET/release/svd2rust $strict $const_generic -i ${1}.svd
+    RUST_BACKTRACE=1 svd2rust $strict $const_generic -i ${1}.svd
 
     mv lib.rs src/lib.rs
 
     popd
 
-    cargo check --manifest-path $td/Cargo.toml
+    cargo $COMMAND --manifest-path $td/Cargo.toml
 }
 
 test_svd_for_target() {
     curl -L --output $td/input.svd $2
 
     # NOTE we care about errors in svd2rust, but not about errors / warnings in rustfmt
-    local cwd=$(pwd)
     pushd $td
-    RUST_BACKTRACE=1 $cwd/target/$TARGET/release/svd2rust $strict $const_generic --target $1 -i input.svd
+    RUST_BACKTRACE=1 svd2rust --target $1 -i input.svd
 
     mv lib.rs src/lib.rs
 
     popd
 
-    cargo check --manifest-path $td/Cargo.toml
+    cargo $COMMAND --manifest-path $td/Cargo.toml
 }
 
 main() {
-    # Ensure that `cargo test` works to avoid surprising people, though it
-    # doesn't help with our actual coverage.
-    cargo test
-
-    if [ $TRAVIS_OS_NAME = windows ]; then
-        cargo check --target $TARGET
-        return
-    fi
-
-    cargo check --target $TARGET
-
     if [ -z ${VENDOR-} ]; then
         return
     fi
 
-    if [ $VENDOR = rustfmt ]; then
-        cargo fmt --all -- --check
-        return
-    fi
-
-    if [ -z ${FEATURES-} ]; then
-      cargo build --target $TARGET --release
-    else
-      cargo build --target $TARGET --release --features $FEATURES
-    fi
-
-    case $TRAVIS_OS_NAME in
-        linux)
-            td=$(mktemp -d)
-            ;;
-        osx)
-            td=$(mktemp -d -t tmp)
-            ;;
-    esac
+    td=$(mktemp -d)
 
     case $OPTIONS in
         all)
@@ -91,9 +60,9 @@ main() {
 
     # test crate
     cargo init --name foo $td
-    echo 'cortex-m = "0.7.0"' >> $td/Cargo.toml
-    echo 'cortex-m-rt = "0.6.13"' >> $td/Cargo.toml
-    echo 'vcell = "0.1.2"' >> $td/Cargo.toml
+    echo 'cortex-m = "0.7.4"' >> $td/Cargo.toml
+    echo 'cortex-m-rt = "0.7.1"' >> $td/Cargo.toml
+    echo 'vcell = "0.1.3"' >> $td/Cargo.toml
     echo '[profile.dev]' >> $td/Cargo.toml
     echo 'incremental = false' >> $td/Cargo.toml