rootcause 0.12.1

A flexible, ergonomic, and inspectable error reporting library for Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101

name: Tests

env:
  CARGO_TERM_COLOR: always

on:
  push:
    branches: ["main"]
  merge_group:
  pull_request:
  schedule:
    - cron: "32 4 * * 5"
  workflow_dispatch:

jobs:
  test:
    strategy:
      fail-fast: false
      matrix:
        os: [ubuntu-latest, windows-latest, macos-latest]
        rust: ["1.89", stable, beta]

    runs-on: ${{ matrix.os }}

    steps:
      - uses: actions/checkout@v6
      - name: Install rust
        uses: dtolnay/rust-toolchain@stable
        with:
          toolchain: ${{ matrix.rust }}
          components: rustfmt, clippy
      - uses: Swatinem/rust-cache@v2

      - name: Run fmt
        run: cargo fmt --check

      - name: Run clippy
        run: |
          cargo clippy -p rootcause -p rootcause-backtrace -p rootcause-tracing --all-targets -- -D warnings
          cargo clippy -p rootcause -p rootcause-backtrace -p rootcause-tracing --all-targets --all-features -- -D warnings
          cargo clippy -p rootcause-internals -- -D warnings

      - name: Run tests
        run: cargo test --workspace --all-targets && cargo test --workspace --all-targets --all-features

      - name: Run doctests
        run: cargo test --workspace --doc && cargo test --workspace --doc --all-features

      - name: Run docs
        run: cargo doc --no-deps -p rootcause -p rootcause-internals -p rootcause-backtrace -p rootcause-tracing --all-features

  cargo-deny:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v6
      - name: Install rust
        uses: dtolnay/rust-toolchain@stable
        with:
          toolchain: stable
      - uses: Swatinem/rust-cache@v2

      - name: Run cargo-deny
        uses: EmbarkStudios/cargo-deny-action@v2

  miri:
    strategy:
      fail-fast: false
      matrix:
        # The windows miri support doesn't seem to be working well currently
        os: [ubuntu-latest, macos-latest]

    runs-on: ${{ matrix.os }}

    steps:
      - uses: actions/checkout@v6
      - name: Install rust
        uses: dtolnay/rust-toolchain@stable
        with:
          toolchain: nightly
          components: miri rust-src
      - uses: Swatinem/rust-cache@v2

      - name: Run tests with miri
        run: |
          export MIRIFLAGS="-Zmiri-strict-provenance"
          cargo miri test -p rootcause -p rootcause-internals -p rootcause-tracing --all-targets
          cargo miri test -p rootcause -p rootcause-internals -p rootcause-tracing --all-features --all-targets

          export MIRIFLAGS="-Zmiri-strict-provenance -Zmiri-isolation-error=warn"
          cargo miri test -p rootcause -p rootcause-internals -p rootcause-tracing --doc
          cargo miri test -p rootcause -p rootcause-internals -p rootcause-tracing --doc --all-features

          # Only run rootcause-backtrace tests on scheduled runs or manual dispatch (slow)
          if [ "${{ github.event_name }}" = "schedule" ] || [ "${{ github.event_name }}" = "workflow_dispatch" ]; then
            echo "Running rootcause-backtrace miri tests (scheduled/manual run)"
            cargo miri test -p rootcause-backtrace --all-targets
            cargo miri test -p rootcause-backtrace --doc
          else
            echo "Skipping rootcause-backtrace miri tests (too slow for push/PR events)"
          fi