Merge pull request zkcrypto#61 from zkcrypto/ci-overhaul

str4d · web-flow · commit 1d32e5f9df4e · 2025-04-16T12:33:06.000+01:00
CI overhaul
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -1,100 +1,93 @@
 name: CI checks
 
-on: [push, pull_request]
+on:
+  pull_request:
+  push:
+    branches: main
 
 jobs:
-  lint:
-    name: Lint
-    runs-on: ubuntu-latest
-
+  test-msrv:
+    name: Test MSRV on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest, macOS-latest]
     steps:
-      - uses: actions/checkout@v1
-      - uses: actions-rs/toolchain@v1
-        with:
-          toolchain: 1.56.0
-          override: true
-
-      # Ensure all code has been formatted with rustfmt
-      - run: rustup component add rustfmt
-      - name: Check formatting
-        uses: actions-rs/cargo@v1
-        with:
-          command: fmt
-          args: -- --check --color always
+      - uses: actions/checkout@v4
+      - name: Run tests
+        run: cargo test --verbose --all-features
+      - name: Verify working directory is clean
+        run: git diff --exit-code
 
-  test:
-    name: Test on ${{ matrix.os }}
+  test-latest:
+    name: Test latest on ${{ matrix.os }}
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
         os: [ubuntu-latest, windows-latest, macOS-latest]
-
     steps:
-      - uses: actions/checkout@v1
-      - uses: actions-rs/toolchain@v1
-        with:
-          toolchain: 1.56.0
-          override: true
-      - name: cargo fetch
-        uses: actions-rs/cargo@v1
-        with:
-          command: fetch
-      - name: Build tests
-        uses: actions-rs/cargo@v1
-        with:
-          command: build
-          args: --verbose --release --tests
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@stable
+        id: toolchain
+      - run: rustup override set ${{steps.toolchain.outputs.name}}
+      - name: Remove lockfile to build with latest dependencies
+        run: rm Cargo.lock
       - name: Run tests
-        uses: actions-rs/cargo@v1
-        with:
-          command: test
-          args: --verbose --release
-      - name: Run --all-features tests
-        uses: actions-rs/cargo@v1
-        with:
-          command: test
-          args: --all-features --verbose --release
+        run: cargo test --verbose --all-features
+      - name: Verify working directory is clean (excluding lockfile)
+        run: git diff --exit-code ':!Cargo.lock'
 
-  no-std:
-    name: Check no-std compatibility
+  build-nodefault:
+    name: Build target ${{ matrix.target }}
     runs-on: ubuntu-latest
-
+    strategy:
+      matrix:
+        target:
+          - wasm32-wasi
+          - thumbv6m-none-eabi
+          - thumbv7em-none-eabihf
     steps:
-      - uses: actions/checkout@v1
-      - uses: actions-rs/toolchain@v1
+      - uses: actions/checkout@v4
         with:
-          toolchain: 1.56.0
-          override: true
-      - run: rustup target add thumbv6m-none-eabi
-      - name: cargo fetch
-        uses: actions-rs/cargo@v1
-        with:
-          command: fetch
-      - name: Build
-        uses: actions-rs/cargo@v1
-        with:
-          command: build
-          args: --verbose --target thumbv6m-none-eabi --no-default-features
+          path: crate_root
+      # We use a synthetic crate to ensure no dev-dependencies are enabled, which can
+      # be incompatible with some of these targets.
+      - name: Create synthetic crate for testing
+        run: cargo init --edition 2021 --lib ci-build
+      - name: Copy Rust version into synthetic crate
+        run: cp crate_root/rust-toolchain.toml ci-build/
+      - name: Copy patch directives into synthetic crate
+        run: |
+          echo "[patch.crates-io]" >> ./ci-build/Cargo.toml
+          cat ./crate_root/Cargo.toml | sed "0,/.\+\(patch.crates.\+\)/d" >> ./ci-build/Cargo.toml
+      - name: Add no_std pragma to lib.rs
+        run: |
+          echo "#![no_std]" > ./ci-build/src/lib.rs
+      - name: Add group as a dependency of the synthetic crate
+        working-directory: ./ci-build
+        # run: cargo add --no-default-features --path ../crate_root
+        run: sed -i 's;\[dependencies\];\[dependencies\]\ngroup = { path = "../crate_root", default-features = false };g' ./Cargo.toml
+      - name: Add target
+        working-directory: ./ci-build
+        run: rustup target add ${{ matrix.target }}
+      - name: Build for target
+        working-directory: ./ci-build
+        run: cargo build --verbose --target ${{ matrix.target }}
 
   doc-links:
-    name: Nightly lint
+    name: Intra-doc links
     runs-on: ubuntu-latest
-
     steps:
-      - uses: actions/checkout@v1
-      - uses: actions-rs/toolchain@v1
-        with:
-          toolchain: nightly
-          override: true
-      - name: cargo fetch
-        uses: actions-rs/cargo@v1
-        with:
-          command: fetch
-
-      # Ensure intra-documentation links all resolve correctly
-      # Requires #![deny(intra_doc_link_resolution_failure)] in crate.
+      - uses: actions/checkout@v4
+      - run: cargo fetch
+      # Requires #![deny(rustdoc::broken_intra_doc_links)] in crates.
+      - run: sudo apt-get -y install libfontconfig1-dev
       - name: Check intra-doc links
-        uses: actions-rs/cargo@v1
-        with:
-          command: doc
-          args: --document-private-items
+        run: cargo doc --all-features --document-private-items
+
+  fmt:
+    name: Rustfmt
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - run: cargo fmt -- --check
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,2 @@
 /target
 **/*.rs.bk
-Cargo.lock
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -5,14 +5,15 @@ authors = [
     "Sean Bowe <ewillbefull@gmail.com>",
     "Jack Grigg <jack@z.cash>",
 ]
+edition = "2021"
+rust-version = "1.56"
 readme = "README.md"
 license = "MIT/Apache-2.0"
 
 description = "Elliptic curve group traits and utilities"
 documentation = "https://docs.rs/group/"
 homepage = "https://github.com/zkcrypto/group"
 repository = "https://github.com/zkcrypto/group"
-edition = "2021"
 
 [dependencies]
 ff = { version = "0.13", default-features = false }
diff --git a/README.md b/README.md
@@ -9,6 +9,13 @@ If you want to propose "substantial" changes to this crate (in particular to the
 `group` traits), please [create an RFC](https://github.com/zkcrypto/rfcs) for
 wider discussion.
 
+## Minimum Supported Rust Version
+
+Requires Rust **1.56** or higher.
+
+Minimum supported Rust version can be changed in the future, but it will be done with a
+minor version bump.
+
 ## License
 
 Licensed under either of
diff --git a/rust-toolchain b/rust-toolchain
diff --git a/rust-toolchain.toml b/rust-toolchain.toml
@@ -0,0 +1,3 @@
+[toolchain]
+channel = "1.56.0"
+components = [ "clippy", "rustfmt" ]

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,2 @@`
`1`	`1`	`/target`
`2`	`2`	`*/.rs.bk`
`3`		`-Cargo.lock`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+[toolchain]`
	`2`	`+channel = "1.56.0"`
	`3`	`+components = [ "clippy", "rustfmt" ]`