more

README.md

@@ -0,0 +1,65 @@
+# Mill Scale
+
+Flakes of rust
+
+## Features
+
+Included checks:
+
+- Verify MSRV (if specified in `Cargo.toml`)
+- Test and clippy with default features
+- Test and clippy with all features (if features are defined)
+- Test and clippy with no default features (if default features are defined)
+
+## Usage with GitHub Actions
+
+### Single runner
+
+```yaml
+name: "CI"
+on:
+  pull_request:
+  push:
+
+jobs:
+  checks:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: cachix/install-nix-action@v26
+        # insert cache setup here
+      - run: nix flake check --keep-going
+```
+
+### Split over multiple runners
+
+```yaml
+name: "CI"
+on:
+  pull_request:
+  push:
+
+jobs:
+  matrix:
+    runs-on: ubuntu-latest
+    outputs:
+      matrix: ${{ steps.set-matrix.outputs.matrix }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: cachix/install-nix-action@v27
+      - id: set-matrix
+        run: echo "matrix={\"check\":$(nix eval --json '.#checks.x86_64-linux' --apply 'builtins.attrNames'}" | tee $GITHUB_OUTPUT
+
+  checks:
+    runs-on: ubuntu-latest
+    needs: [matrix]
+    strategy:
+      fail-fast: false
+      matrix: ${{fromJson(needs.miri-matrix.outputs.matrix)}}
+    name: ${{ matrix.check }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: cachix/install-nix-action@v26
+        # insert cache setup here
+      - run: nix build .#checks.x86_64-linux.${{ matrix.check }}
+```