scrubbers 0.1.1

High-throughput redaction engine + CLI
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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116

name: CI

on:
  pull_request:
  push:
    branches: ["**"]

jobs:
  core:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Setup Rust
        uses: dtolnay/rust-toolchain@stable
        with:
          components: rustfmt, clippy

      - name: Setup Python
        uses: actions/setup-python@v5
        with:
          python-version: "3.11"

      - name: Setup Go
        uses: actions/setup-go@v5
        with:
          go-version: "1.26"

      - name: Resolve pinned TruffleHog commit
        run: |
          echo 'TRUFFLEHOG_REF<<EOF' >> "$GITHUB_ENV"
          sed -n 's/^pub const TRUFFLEHOG_SOURCE_COMMIT: &str = "\([^"]*\)";$/\1/p' src/generated_trufflehog.rs >> "$GITHUB_ENV"
          echo 'EOF' >> "$GITHUB_ENV"

      - name: Sync TruffleHog signatures
        run: python scripts/sync_trufflehog_signatures.py --ref "$TRUFFLEHOG_REF"

      - name: Sync TruffleHog pattern fixtures
        run: go run ./scripts/sync_trufflehog_pattern_fixtures.go --ref "$TRUFFLEHOG_REF"

      - name: Verify TruffleHog detector coverage
        run: python scripts/verify_trufflehog_coverage.py --ref "$TRUFFLEHOG_REF"

      - name: Verify generated artifacts are committed
        run: git diff --exit-code -- src/generated_trufflehog.rs tests/generated_trufflehog_pattern_fixtures.rs

      - name: Rust format check
        run: cargo fmt --check

      - name: Unit and integration tests
        run: cargo test --all-targets

      - name: Verify crates.io package
        run: cargo publish --dry-run --locked --allow-dirty --package scrubbers

  python-package:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Setup Rust
        uses: dtolnay/rust-toolchain@stable

      - name: Setup Python
        uses: actions/setup-python@v5
        with:
          python-version-file: ".python-version"

      - name: Setup uv
        uses: astral-sh/setup-uv@v7
        with:
          enable-cache: true

      - name: Build and smoke test Python package
        run: python scripts/test_python_package.py --artifact all

  python-binding:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Setup Rust
        uses: dtolnay/rust-toolchain@stable

      - name: Setup Python
        uses: actions/setup-python@v5
        with:
          python-version: "3.11"

      - name: Python binding smoke test
        run: python3 scripts/test_bindings.py --binding python

  node-binding:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Setup Rust
        uses: dtolnay/rust-toolchain@stable

      - name: Setup Python
        uses: actions/setup-python@v5
        with:
          python-version: "3.11"

      - name: Setup Node
        uses: actions/setup-node@v4
        with:
          node-version: "22"

      - name: Node binding smoke test
        run: python3 scripts/test_bindings.py --binding node