feat: ci

.cargo/config.toml

@@ -0,0 +1,2 @@
+[alias]
+docs = "doc --workspace --all-features --no-deps"

.codespellrc

@@ -0,0 +1,3 @@
+[codespell]
+skip = .git,target,Cargo.toml,Cargo.lock
+ignore-words-list = crate

.config/zepter.yaml

@@ -0,0 +1,39 @@
+version:
+  format: 1
+  # Minimum zepter version that is expected to work. This is just for printing a nice error
+  # message when someone tries to use an older version.
+  binary: 0.13.2
+
+# The examples in the following comments assume crate `A` to have a dependency on crate `B`.
+workflows:
+  check:
+    - [
+        "lint",
+        # Check that `A` activates the features of `B`.
+        "propagate-feature",
+        # These are the features to check:
+        "--features=std,dev,test-utils,serde-bincode-compat,serde,test-utils,arbitrary,bench",
+        # Do not try to add a new section into `[features]` of `A` only because `B` expose that feature. There are edge-cases where this is still needed, but we can add them manually.
+        "--left-side-feature-missing=ignore",
+        # Ignore the case that `A` it outside of the workspace. Otherwise it will report errors in external dependencies that we have no influence on.
+        "--left-side-outside-workspace=ignore",
+        # Auxilary flags:
+        "--offline",
+        "--locked",
+        "--show-path",
+        "--quiet",
+      ]
+  default:
+    # Running `zepter` with no subcommand will check & fix.
+    - [$check.0, "--fix"]
+
+# Will be displayed when any workflow fails:
+help:
+  text: |
+    We uses the Zepter CLI to detect abnormalities in Cargo features, e.g. missing propagation.
+
+    It looks like one more checks failed; please check the console output.
+
+    You can try to automatically address them by installing zepter (`cargo install zepter --locked`) and simply running `zepter` in the workspace root.
+  links:
+    - "https://github.com/ggwpez/zepter"

.github/assets/check_no_std.sh

@@ -0,0 +1,60 @@
+#!/usr/bin/env bash
+set +e  # Disable immediate exit on error
+
+crates=($(cargo metadata --format-version=1 --no-deps | jq -r '.packages[].name' | sort))
+
+IFS=',' read -ra exclude_crates <<< "$EXCLUDE"
+unset IFS
+
+contains() {
+  local ex="$1[@]"
+  local input=$2
+
+  for ignore in "${!ex}";
+  do
+    if [ "$ignore" = "$input" ];
+    then
+      return 0
+    fi
+  done
+  return 1
+}
+
+results=()
+any_failed=0
+
+for crate in "${crates[@]}";
+do
+  if contains exclude_crates "$crate";
+  then
+    results+=("⏭️ $crate")
+    continue
+  fi
+
+  cmd="cargo +stable build -p $crate --target $TARGET --no-default-features"
+
+  set +e  # Disable immediate exit on error
+  # Run the command and capture the return code
+#  $cmd
+  ret_code=$?
+  set -e  # Re-enable immediate exit on error
+
+  if [ $ret_code -eq 0 ];
+  then
+    results+=("✅  $crate")
+  else
+    results+=("❌  $crate")
+    any_failed=1
+  fi
+done
+
+IFS=$'\n' sorted=$(sort <<< "${results[*]}")
+unset IFS
+
+printf "Build results: \n"
+for result in "${sorted[@]}";
+do
+  echo "${result}"
+done
+
+exit $any_failed

.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+- package-ecosystem: "github-actions"
+  directory: "/"
+  schedule:
+    interval: "weekly"

.github/workflows/lint.yaml

@@ -0,0 +1,140 @@
+name: lint
+
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  clippy:
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - uses: actions/checkout@v4
+      - uses: rui314/setup-mold@v1
+      - uses: dtolnay/rust-toolchain@clippy
+        with:
+          components: clippy
+      - uses: Swatinem/rust-cache@v2
+        with:
+          cache-on-failure: true
+      - name: Run clippy
+        run: cargo clippy --workspace --lib --examples --tests --benches --all-features --locked
+        env:
+          RUSTFLAGS: -D warnings
+
+  fmt:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - uses: actions/checkout@v4
+      - uses: rui314/setup-mold@v1
+      - uses: dtolnay/rust-toolchain@nightly
+        with:
+          components: rustfmt
+      - name: Run fmt
+        run: cargo fmt --all --check
+
+  udeps:
+    runs-on: ubuntu-latest
+    timeout-minutes: 60
+    steps:
+      - uses: actions/checkout@v4
+      - uses: rui314/setup-mold@v1
+      - uses: dtolnay/rust-toolchain@nightly
+      - uses: Swatinem/rust-cache@v2
+        with:
+          cache-on-failure: true
+      - uses: taiki-e/install-action@cargo-udeps
+      - name: Run udeps
+        run: cargo udeps --workspace --lib --examples --tests --benches --all-features --locked
+
+  zepter:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - uses: actions/checkout@v4
+      - uses: cargo-bins/cargo-binstall@main
+      - name: fetch deps
+        run: |
+          # Eagerly pull dependencies
+          cargo metadata --format-version=1 --locked > /dev/null
+      - name: run zepter
+        run: |
+          cargo binstall zepter --force -y --locked
+          zepter run check
+
+  docs:
+    runs-on: ubuntu-latest
+    timeout-minutes: 60
+    steps:
+      - uses: actions/checkout@v4
+      - uses: rui314/setup-mold@v1
+      - uses: dtolnay/rust-toolchain@nightly
+      - uses: Swatinem/rust-cache@v2
+        with:
+          cache-on-failure: true
+      - name: Run doc
+        run: cargo docs --document-private-items
+        env:
+          RUSTDOCFLAGS: --cfg docsrs --show-type-layout --generate-link-to-definition --enable-index-page -Zunstable-options -D warnings
+
+  codespell:
+    runs-on: ubuntu-latest
+    timeout-minutes: 60
+    steps:
+      - uses: actions/checkout@v4
+      - uses: codespell-project/actions-codespell@v2
+        with:
+          skip: "*.json"
+
+  features:
+    runs-on: ubuntu-latest
+    timeout-minutes: 60
+    steps:
+      - uses: actions/checkout@v4
+      - uses: rui314/setup-mold@v1
+      - uses: dtolnay/rust-toolchain@stable
+      - uses: taiki-e/install-action@cargo-hack
+      - uses: Swatinem/rust-cache@v2
+        with:
+          cache-on-failure: true
+      - name: Run feature check
+        run: cargo hack check --feature-powerset --no-dev-deps
+
+  no_std:
+    runs-on: ubuntu-latest
+    timeout-minutes: 60
+    strategy:
+      matrix:
+        include:
+          - type: wasm
+            target: wasm32-unknown-unknown
+            exclude: engine,scroll-wire,scroll-bridge,scroll-network
+          - type: riscv
+            target: riscv32imac-unknown-none-elf
+            exclude: engine,scroll-wire,scroll-bridge,scroll-network
+    steps:
+      - uses: actions/checkout@v4
+      - uses: rui314/setup-mold@v1
+      - uses: dcarbone/install-jq-action@v3
+      - uses: dtolnay/rust-toolchain@stable
+        with:
+          targets: ${{ matrix.target }}
+      - uses: Swatinem/rust-cache@v2
+        with:
+          cache-on-failure: true
+      - name: Run no_std check
+        run: |
+          sudo apt update && sudo apt install gcc-multilib
+          .github/assets/check_no_std.sh
+        env:
+          TARGET: ${{ matrix.target }}
+          EXCLUDE: ${{ matrix.exclude }}

.github/workflows/test.yaml

@@ -0,0 +1,50 @@
+name: test
+
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  unit:
+    runs-on: ubuntu-latest
+    timeout-minutes: 60
+    env:
+      RUST_BACKTRACE: 1
+    steps:
+      - uses: actions/checkout@v4
+      - uses: rui314/setup-mold@v1
+      - uses: dtolnay/rust-toolchain@nightly
+        with:
+          toolchain: 'nightly'
+      - uses: Swatinem/rust-cache@v2
+        with:
+          cache-on-failure: true
+      - uses: taiki-e/install-action@nextest
+      - name: Run unit tests
+        run: cargo nextest run --workspace --locked -E '!kind(test)'
+
+  it:
+    runs-on: ubuntu-latest
+    timeout-minutes: 60
+    env:
+      RUST_BACKTRACE: 1
+    steps:
+      - uses: actions/checkout@v4
+      - uses: rui314/setup-mold@v1
+      - uses: dtolnay/rust-toolchain@nightly
+        with:
+          toolchain: 'nightly'
+      - uses: Swatinem/rust-cache@v2
+        with:
+          cache-on-failure: true
+      - uses: taiki-e/install-action@nextest
+      - name: Run integration tests
+        run: cargo nextest run --workspace --locked --no-tests=pass -E 'kind(test)'

.gitignore

@@ -3,10 +3,6 @@
 debug/
 target/
 
-# Remove Cargo.lock from gitignore if creating an executable, leave it for libraries
-# More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html
-Cargo.lock
-
 # These are backup files generated by rustfmt
 **/*.rs.bk
 
@@ -23,3 +19,7 @@ Cargo.lock
 # Added by cargo
 
 /target
+
+.vscode/
+
+.idea/