build: set up workspace layout (#43)

* build: set up workspace layout

Signed-off-by: tison <[email protected]>

* fixup

Signed-off-by: tison <[email protected]>

* try fix windows compile

Signed-off-by: tison <[email protected]>

* fix(xtask): exclude xtask binary from build command to avoid file locking on Windows

* workaround windows issue

Signed-off-by: tison <[email protected]>

* windows runner has no yq

Signed-off-by: tison <[email protected]>

---------

Signed-off-by: tison <[email protected]>

Author: tisonkun

.cargo/config.toml

@@ -0,0 +1,22 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+[alias]
+x = "run --package x --"
+
+[env]
+CARGO_WORKSPACE_DIR = { value = "", relative = true }

.github/workflows/ci.yml

@@ -34,6 +34,10 @@ on:
 concurrency:
   group: ${{ github.workflow }}-${{ github.event_name }}-${{ github.event.number || github.run_id }}
   cancel-in-progress: true
+
+env:
+  RUST_BACKTRACE: 1
+
 jobs:
   check:
     name: Check
@@ -49,12 +53,7 @@ jobs:
         with:
           tool: typos-cli,taplo-cli,hawkeye
       - name: Check all
-        run: |
-          hawkeye check
-          taplo format --check
-          typos
-          cargo +nightly fmt --all -- --check
-          cargo +nightly clippy --all-targets --all-features -- -D warnings
+        run: cargo x lint
 
   msrv:
     name: Resolve MSRV
@@ -65,7 +64,7 @@ jobs:
       - uses: actions/checkout@v6
       - id: metadata
         run: |
-          msrv=$(yq '.package.rust-version' Cargo.toml)
+          msrv=$(yq '.workspace.package.rust-version' Cargo.toml)
           echo "MSRV: $msrv"
           echo "rust-versions=[\"${msrv}\", \"stable\"]" >> "$GITHUB_OUTPUT"
 
@@ -94,16 +93,18 @@ jobs:
       - name: Prepare test data
         shell: bash
         run: ./tools/generate_serialization_test_data.py
-      - name: Build
-        run: cargo build --workspace --all-features --bins --tests --examples --benches --lib
       - name: Run unit tests
         shell: bash
-        run: cargo test --all-features -- --nocapture
+        run: cargo x test
       - name: Run examples
         shell: bash
+        working-directory: examples
         run: |
           set -x
-          cargo run --example hll_usage
+          EXAMPLES=( hll_update )
+          for example in $EXAMPLES; do
+            cargo run --bin "$example"
+          done
 
   required:
     name: Required

CONTRIBUTING.md

@@ -30,13 +30,7 @@ cargo version
 # cargo 1.85.0 (<hash> 2024-12-31)
 ```
 
-To keep code style consistent, we use the following tools:
-
-* Nightly `rustfmt` for code formatting: `cargo +nightly fmt --all -- --check`
-* Nightly `clippy` for linting: `cargo +nightly clippy --all-targets --all-features -- -D warnings`
-* [`typos`](https://github.com/crate-ci/typos) for spell checking: `cargo install typos-cli` and then `typos`
-* [`taplo`](https://taplo.tamasfe.dev/) for checking `toml` files: `cargo install taplo-cli` and then `taplo check`
-* [`hawkeye`](https://github.com/korandoru/hawkeye) for checking license header: `cargo install hawkeye` and then `hawkeye check`
+To keep code style consistent, run `cargo x lint --fix` to automatically fix any style issues before committing your changes.
 
 ## Code of Conduct