Merge pull request #125 from cuviper/ci

ci: merge queue and registry caching

.github/workflows/ci.yaml

@@ -1,9 +1,5 @@
 name: CI
-on:
-  push:
-    branches:
-      - staging
-      - trying
+on: merge_group
 
 jobs:
 
@@ -21,6 +17,11 @@ jobs:
         ]
     steps:
       - uses: actions/checkout@v4
+      - uses: actions/cache@v4
+        if: startsWith(matrix.rust, '1')
+        with:
+          path: ~/.cargo/registry/index
+          key: cargo-${{ matrix.rust }}-git-index
       - uses: dtolnay/rust-toolchain@master
         with:
           toolchain: ${{ matrix.rust }}
@@ -44,6 +45,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
+      - uses: actions/cache@v4
+        with:
+          path: ~/.cargo/registry/index
+          key: cargo-1.31.0-git-index
       - uses: dtolnay/rust-toolchain@1.31.0
         with:
           target: thumbv6m-none-eabi
@@ -58,3 +63,18 @@ jobs:
         with:
           components: rustfmt
       - run: cargo fmt --all --check
+
+  # One job that "summarizes" the success state of this pipeline. This can then be added to branch
+  # protection, rather than having to add each job separately.
+  success:
+    name: Success
+    runs-on: ubuntu-latest
+    needs: [test, no_std_131, no_std_stable, fmt]
+    # Github branch protection is exceedingly silly and treats "jobs skipped because a dependency
+    # failed" as success. So we have to do some contortions to ensure the job fails if any of its
+    # dependencies fails.
+    if: always() # make sure this is never "skipped"
+    steps:
+      # Manually check the status of all dependencies. `if: failure()` does not work.
+      - name: check if any dependency failed
+        run: jq --exit-status 'all(.result == "success")' <<< '${{ toJson(needs) }}'

.github/workflows/master.yaml

@@ -16,6 +16,11 @@ jobs:
         rust: [1.31.0, stable]
     steps:
       - uses: actions/checkout@v4
+      - uses: actions/cache@v4
+        if: startsWith(matrix.rust, '1')
+        with:
+          path: ~/.cargo/registry/index
+          key: cargo-${{ matrix.rust }}-git-index
       - uses: dtolnay/rust-toolchain@master
         with:
           toolchain: ${{ matrix.rust }}

.github/workflows/pr.yaml

@@ -12,6 +12,11 @@ jobs:
         rust: [1.31.0, stable]
     steps:
       - uses: actions/checkout@v4
+      - uses: actions/cache@v4
+        if: startsWith(matrix.rust, '1')
+        with:
+          path: ~/.cargo/registry/index
+          key: cargo-${{ matrix.rust }}-git-index
       - uses: dtolnay/rust-toolchain@master
         with:
           toolchain: ${{ matrix.rust }}
@@ -27,3 +32,18 @@ jobs:
         with:
           components: rustfmt
       - run: cargo fmt --all --check
+
+  # One job that "summarizes" the success state of this pipeline. This can then be added to branch
+  # protection, rather than having to add each job separately.
+  success:
+    name: Success
+    runs-on: ubuntu-latest
+    needs: [test, fmt]
+    # Github branch protection is exceedingly silly and treats "jobs skipped because a dependency
+    # failed" as success. So we have to do some contortions to ensure the job fails if any of its
+    # dependencies fails.
+    if: always() # make sure this is never "skipped"
+    steps:
+      # Manually check the status of all dependencies. `if: failure()` does not work.
+      - name: check if any dependency failed
+        run: jq --exit-status 'all(.result == "success")' <<< '${{ toJson(needs) }}'

Cargo.toml

@@ -10,7 +10,7 @@ name = "num-rational"
 repository = "https://github.com/rust-num/num-rational"
 version = "0.4.1"
 readme = "README.md"
-exclude = ["/bors.toml", "/ci/*", "/.github/*"]
+exclude = ["/ci/*", "/.github/*"]
 edition = "2018"
 
 [package.metadata.docs.rs]