ci: include checks, coverage and test

.github/workflows/check.yml

@@ -0,0 +1,113 @@
+name: check
+# This workflow runs whenever a PR is opened or updated, or a commit is pushed
+# to main. It runs several checks:
+# - fmt: checks that the code is formatted according to `rustfmt`.
+# - clippy: checks that the code does not contain any `clippy` warnings.
+# - doc: checks that the code can be documented without errors.
+# - hack: check combinations of feature flags.
+# - typos: checks for typos across the repo.
+permissions:
+  contents: read
+# This configuration allows maintainers of this repo to create a branch and
+# pull request based on the new branch. Restricting the push trigger to the
+# main branch ensures that the PR only gets built once.
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+# If new code is pushed to a PR branch, then cancel in progress workflows for
+# that PR. Ensures that we don't waste CI time, and returns results quicker.
+# https://github.com/jonhoo/rust-ci-conf/pull/5
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+env:
+  CARGO_TERM_COLOR: always
+jobs:
+  fmt:
+    runs-on: ubuntu-latest
+    name: nightly / fmt
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: true
+      - name: Install stable
+        # We run in nightly to make use of some features only available there.
+        # Check out `rustfmt.toml` to see which ones.
+        uses: dtolnay/rust-toolchain@nightly
+        with:
+          components: rustfmt
+      - name: cargo fmt --all --check
+        run: cargo fmt --all --check
+  clippy:
+    runs-on: ubuntu-latest
+    name: ${{ matrix.toolchain }} / clippy
+    permissions:
+      contents: read
+      checks: write
+    strategy:
+      fail-fast: false
+      matrix:
+        # Get early warning of new lints which are regularly introduced in beta
+        # channels.
+        toolchain: [ stable, beta ]
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: true
+      - name: Install ${{ matrix.toolchain }}
+        uses: dtolnay/rust-toolchain@master
+        with:
+          toolchain: ${{ matrix.toolchain }}
+          components: clippy
+      - name: cargo clippy
+        uses: giraffate/clippy-action@v1
+        with:
+          reporter: 'github-pr-check'
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+  doc:
+    # Run docs generation on nightly rather than stable. This enables features
+    # like https://doc.rust-lang.org/beta/unstable-book/language-features/doc-cfg.html
+    # which allows an API be documented as only available in some specific
+    # platforms.
+    runs-on: ubuntu-latest
+    name: nightly / doc
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: true
+      - name: Install nightly
+        uses: dtolnay/rust-toolchain@nightly
+      - name: cargo doc
+        run: cargo doc --no-deps --all-features
+        env:
+          RUSTDOCFLAGS: --cfg docsrs
+  hack:
+    # `cargo-hack` checks combinations of feature flags to ensure that features
+    # are all additive which is required for feature unification.
+    runs-on: ubuntu-latest
+    name: ubuntu / stable / features
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: true
+      - name: Install stable
+        uses: dtolnay/rust-toolchain@stable
+        with:
+          target: wasm32-unknown-unknown
+      - name: cargo install cargo-hack
+        uses: taiki-e/install-action@cargo-hack
+        # Intentionally no target specifier; see https://github.com/jonhoo/rust-ci-conf/pull/4
+        # `--feature-powerset` runs for every combination of features. Note that
+        # target in this context means one of `--lib`, `--bin`, etc, and not the
+        # target triple.
+      - name: cargo hack
+        run: cargo hack check --feature-powerset --depth 2 --release --target wasm32-unknown-unknown --skip std --workspace --exclude e2e --exclude basic-example-script --exclude benches
+  typos:
+    runs-on: ubuntu-latest
+    name: ubuntu / stable / typos
+    steps:
+      - name: Checkout Actions Repository
+        uses: actions/checkout@v4
+      - name: Check spelling of files in the workspace
+        uses: crate-ci/[email protected]

.github/workflows/coverage.yml

@@ -0,0 +1,52 @@
+name: coverage
+permissions:
+  contents: read
+on:
+  push:
+    branches: [ main ]
+    paths-ignore:
+      - "**.ts"
+  pull_request:
+    paths-ignore:
+      - "**.ts"
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+env:
+  CARGO_TERM_COLOR: always
+jobs:
+    required:
+        runs-on: ubuntu-latest
+        name: ubuntu / ${{ matrix.toolchain }}
+        strategy:
+            matrix:
+              # Run on stable and beta to ensure that tests won't break on the next
+              # version of the rust toolchain.
+              toolchain: [ stable, beta ]
+    coverage:
+        runs-on: ubuntu-latest
+        name: ubuntu / stable / coverage
+        steps:
+        - uses: actions/checkout@v4
+          with:
+            submodules: true
+        - name: Install stable
+          uses: dtolnay/rust-toolchain@stable
+          with:
+            components: llvm-tools-preview
+        - name: cargo install cargo-llvm-cov
+          uses: taiki-e/install-action@cargo-llvm-cov
+        - name: cargo generate-lockfile
+          if: hashFiles('Cargo.lock') == ''
+          run: cargo generate-lockfile
+        - name: cargo llvm-cov
+            # FIXME: Include e2e tests in coverage.
+          run: cargo llvm-cov --locked --features std --lcov --output-path lcov.info
+        - name: Record Rust version
+          run: echo "RUST=$(rustc --version)" >> "$GITHUB_ENV"
+        - name: Upload to codecov.io
+          uses: codecov/codecov-action@v4
+          with:
+            fail_ci_if_error: true
+            token: ${{ secrets.CODECOV_TOKEN }}
+            env_vars: OS,RUST

.github/workflows/nostd.yml

@@ -8,33 +8,25 @@ on:
   push:
     branches: [ main ]
   pull_request:
-
 concurrency:
   group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
   cancel-in-progress: true
-
 env:
   CARGO_TERM_COLOR: always
-
 jobs:
   nostd:
     runs-on: ubuntu-latest
     name: ${{ matrix.target }}
-
     strategy:
       matrix:
         target: [ wasm32-unknown-unknown ]
-
     steps:
       - uses: actions/checkout@v4
         with:
           submodules: true
-
       - name: Install stable
         uses: dtolnay/rust-toolchain@stable
-
       - name: rustup target add ${{ matrix.target }}
         run: rustup target add ${{ matrix.target }}
-
       - name: cargo check
         run: cargo check --release --target ${{ matrix.target }} --no-default-features

.github/workflows/test.yml

@@ -0,0 +1,76 @@
+name: test
+# This is the main CI workflow that runs the test suite on all pushes to main
+# and all pull requests. It runs the following jobs:
+# - required: runs the test suite on ubuntu with stable and beta rust
+# toolchains.
+# - os-check: runs the test suite on mac and windows.
+# - coverage: runs the test suite and collects coverage information.
+# See `check.yml` for information about how the concurrency cancellation and
+# workflow triggering works.
+permissions:
+  contents: read
+on:
+  push:
+    branches: [ main ]
+    paths-ignore:
+      - "**.md"
+      - "**.adoc"
+  pull_request:
+    paths-ignore:
+      - "**.md"
+      - "**.adoc"
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+env:
+  CARGO_TERM_COLOR: always
+jobs:
+  required:
+    runs-on: ubuntu-latest
+    name: ubuntu / ${{ matrix.toolchain }}
+    strategy:
+      matrix:
+        # Run on stable and beta to ensure that tests won't break on the next
+        # version of the rust toolchain.
+        toolchain: [ stable, beta ]
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: true
+      - name: Install ${{ matrix.toolchain }}
+        uses: dtolnay/rust-toolchain@master
+        with:
+          toolchain: ${{ matrix.toolchain }}
+      - name: cargo generate-lockfile
+        # Enable this ci template to run regardless of whether the lockfile is
+        # checked in or not.
+        if: hashFiles('Cargo.lock') == ''
+        run: cargo generate-lockfile
+        # https://twitter.com/jonhoo/status/1571290371124260865
+      - name: cargo test --locked
+        run: cargo test --locked --features std --all-targets
+        # https://github.com/rust-lang/cargo/issues/6669
+      - name: cargo test --doc
+        run: cargo test --locked --features std --doc
+  os-check:
+    # Run cargo test on MacOS and Windows.
+    runs-on: ${{ matrix.os }}
+    name: ${{ matrix.os }} / stable
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ macos-latest ]
+        # Windows fails because of `stylus-proc`.
+        # os: [macos-latest, windows-latest]
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: true
+      - name: Install stable
+        uses: dtolnay/rust-toolchain@stable
+      - name: cargo generate-lockfile
+        if: hashFiles('Cargo.lock') == ''
+        run: cargo generate-lockfile
+      - name: cargo test
+        run: cargo test --locked --features std --all-targets
+