tarzan 0.4.0

Random-access, seekable .tar.zst archives with an embedded table-of-contents index
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

name: CI

on:
  push:
  pull_request:

jobs:
  # Linux carries the OS-agnostic checks (fmt, clippy, the
  # THIRD-PARTY-LICENSES libzstd sanity check) on top of the test suite.
  # The other two jobs run the test suite only.
  check:
    name: lint + test (linux)
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v6

      - name: Verify THIRD-PARTY-LICENSES retains the libzstd entry
        run: |
          if ! grep -q '^- package_name: libzstd$' THIRD-PARTY-LICENSES \
             || ! grep -q 'Copyright (c) Meta Platforms' THIRD-PARTY-LICENSES; then
            echo "::error::THIRD-PARTY-LICENSES is missing the hand-maintained libzstd entry — re-add it after regenerating (see CONTRIBUTING.md)."
            exit 1
          fi

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

      - name: Check formatting
        run: cargo fmt --all --check

      - name: Clippy (warnings denied)
        run: cargo clippy --all-targets -- -D warnings

      - name: Clippy (pure-rust feature)
        run: cargo clippy --all-targets --no-default-features --features pure-rust -- -D warnings

      - name: Test
        run: cargo test

      - name: Test (pure-rust feature)
        run: cargo test --no-default-features --features pure-rust

  test-macos:
    name: test (macos)
    runs-on: macos-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v6

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

      - name: Test
        run: cargo test

  # Runs cargo-semver-checks against the last version tag.  If a breaking
  # API change is detected, the job requires at least one commit since that
  # tag to acknowledge it with feat!:, fix!:, or a BREAKING CHANGE footer.
  semver-check:
    name: semver compatibility
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
        with:
          fetch-depth: 0
      - uses: dtolnay/rust-toolchain@stable
      - uses: taiki-e/install-action@v2
        with:
          tool: cargo-semver-checks
      - name: Check for undeclared breaking changes
        run: |
          LAST_TAG=$(git describe --tags --match 'v*' --abbrev=0 2>/dev/null || echo "")
          if [ -z "$LAST_TAG" ]; then
            echo "No prior version tag; skipping semver check."
            exit 0
          fi
          echo "Comparing against $LAST_TAG"
          if cargo semver-checks check-release --baseline-rev "$LAST_TAG" --default-features; then
            exit 0
          fi
          # cargo-semver-checks found a breaking change.  Acceptable only when the
          # conventional-commit history since the last tag acknowledges it.
          COMMITS=$(git log "${LAST_TAG}..HEAD" --format="%s%n%b")
          if echo "$COMMITS" | grep -qE '^(feat|fix|[a-z]+)(\([^)]*\))?!:|BREAKING[ -]CHANGE'; then
            echo "Breaking change is acknowledged in commit history — version bump required."
            exit 0
          fi
          echo "::error::cargo-semver-checks found a breaking API change not acknowledged"
          echo "::error::in any commit since ${LAST_TAG}.  Add feat!: / fix!: or a"
          echo "::error::BREAKING CHANGE footer to the responsible commit, or revert the break."
          exit 1

  # Tests that touch Unix-only APIs (symlink creation, MetadataExt mtime,
  # Unix permission bits) are gated with `#[cfg(unix)]` and don't compile
  # in here. The remaining tests shell out to `tar`, which Windows
  # provides as bsdtar.
  test-windows:
    name: test (windows)
    runs-on: windows-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v6

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

      - name: Test
        run: cargo test