update README, add link to doc website #52
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: CI | |
| on: | |
| push: | |
| branches: [ "main" ] | |
| pull_request: | |
| jobs: | |
| build: | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| os: [windows-2022, macos-14] | |
| runs-on: ${{ matrix.os }} | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Setup .NET 10 | |
| uses: actions/setup-dotnet@v4 | |
| with: | |
| dotnet-version: '10.0.x' | |
| # The native notification cdylib (native/yasn-notify) is built by an MSBuild target during | |
| # build/test/publish, so the Rust toolchain must be present before the Build step. The target | |
| # only builds the runner's own RID here (Rust can cross-compile darwin<->darwin, but CI just | |
| # needs the host arch). uniffi-bindgen-cs regenerates the committed C# bindings for the drift | |
| # check below; its tag pins the matching uniffi crate version (v0.11.0 -> uniffi 0.31.0). | |
| - name: Setup Rust | |
| uses: dtolnay/rust-toolchain@stable | |
| - name: Cache Rust build | |
| uses: Swatinem/rust-cache@v2 | |
| with: | |
| workspaces: native/yasn-notify | |
| - name: Install uniffi-bindgen-cs | |
| run: cargo install uniffi-bindgen-cs --git https://github.com/NordSecurity/uniffi-bindgen-cs --tag v0.11.0+v0.31.0 --locked | |
| # Regenerate the committed UniFFI bindings from a freshly built cdylib and fail if they drift. | |
| # The generated file is committed (so the app compiles without Rust), so a stale checkout would | |
| # otherwise silently diverge from the native ABI. | |
| - name: Verify generated bindings are up to date | |
| shell: bash | |
| run: | | |
| if [ "$RUNNER_OS" = "Windows" ]; then triple=x86_64-pc-windows-msvc; lib=yasn_notify.dll; else triple=aarch64-apple-darwin; lib=libyasn_notify.dylib; fi | |
| # uniffi-bindgen-cs runs `cargo metadata` from its working dir, so generate from the crate. | |
| ( cd native/yasn-notify && \ | |
| cargo build --release --target "$triple" && \ | |
| uniffi-bindgen-cs --library "target/$triple/release/$lib" --config uniffi.toml --out-dir target/cs-check ) | |
| # Compare line-ending-normalized (committed file is CRLF per .gitattributes). | |
| sed 's/\r$//' src/YASN.App/Notifications/Generated/yasn_notify.cs > /tmp/committed.cs | |
| sed 's/\r$//' native/yasn-notify/target/cs-check/yasn_notify.cs > /tmp/fresh.cs | |
| diff -u /tmp/committed.cs /tmp/fresh.cs | |
| - name: Restore | |
| run: dotnet restore YASN.sln | |
| - name: Lint (dotnet format) | |
| run: dotnet format YASN.sln --verify-no-changes --no-restore | |
| - name: Build | |
| run: dotnet build YASN.sln -c Release --no-restore | |
| - name: Test | |
| run: dotnet test YASN.sln -c Release --no-build | |
| # Smoke-test the NativeAOT publish so trim/AOT breakage (a new reflection-based JSON call, an | |
| # uncompiled binding, a missing trimmer root) is caught on PRs, not only at release time. AOT | |
| # can't cross-compile, so each runner publishes its own RID; the runner images supply the | |
| # native toolchain the link step needs. This rebuilds from source (an AOT publish cannot reuse | |
| # the JIT build above), so it is the slowest CI step by design. | |
| # | |
| # NO --no-restore: the RID-specific runtime.<rid>.microsoft.dotnet.ilcompiler package is only | |
| # restored when restore runs with this RID + EnableAot. The earlier `dotnet restore YASN.sln` | |
| # (no RID, no flag) doesn't pull it, so a --no-restore AOT publish silently skips ILC and | |
| # emits only YASN.dll — the smoke test would pass without ever exercising AOT. | |
| - name: AOT publish smoke | |
| shell: bash | |
| run: | | |
| if [ "$RUNNER_OS" = "Windows" ]; then rid=win-x64; else rid=osx-arm64; fi | |
| dotnet publish src/YASN.App/YASN.App.csproj -c Release -p:EnableAot=true -r "$rid" -o publish/aot-smoke |