dejadoc 0.5.0

Find duplicated Rust doctests and functions across a workspace
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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148

name: Release

on:
  push:
    tags:
      - "v*.*"

permissions:
  contents: read

env:
  CARGO_TERM_COLOR: always

jobs:
  verify-version:
    name: Verify tag matches version
    runs-on: ubuntu-latest
    outputs:
      crate-release: ${{ steps.check.outputs.crate-release }}

    steps:
      - name: Checkout
        uses: actions/checkout@fbc6f3992d24b796d5a048ff273f7fcc4a7b6c09 # v5

      - name: Check tag against Cargo.toml version
        id: check
        run: |
          tag="${GITHUB_REF_NAME#v}"
          manifest="$(grep -m1 '^version = ' Cargo.toml | sed -E 's/version = "(.*)"/\1/')"
          echo "tag version: $tag"
          echo "manifest version: $manifest"
          if [ "$tag" = "$manifest" ]; then
            echo "crate-release=true" >> "$GITHUB_OUTPUT"
          elif [ "${tag%%.*}" != "${manifest%%.*}" ]; then
            echo "tag $tag is not a crate release tag for version $manifest, skipping" >> "$GITHUB_STEP_SUMMARY"
            echo "crate-release=false" >> "$GITHUB_OUTPUT"
          else
            echo "::error::tag $tag does not match Cargo.toml version $manifest"
            exit 1
          fi

  ci:
    name: CI
    needs: verify-version
    if: needs.verify-version.outputs.crate-release == 'true'
    uses: ./.github/workflows/ci.yml
    secrets: inherit

  publish:
    name: Publish to crates.io
    needs: ci
    runs-on: ubuntu-latest
    permissions:
      contents: read
      id-token: write

    steps:
      - name: Checkout
        uses: actions/checkout@fbc6f3992d24b796d5a048ff273f7fcc4a7b6c09 # v5

      - name: Install stable toolchain
        uses: dtolnay/rust-toolchain@6bed0761d98439e5a578e2877258200ad565ba87 # stable
        with:
          toolchain: stable

      - name: Authenticate to crates.io
        id: auth
        uses: rust-lang/crates-io-auth-action@c6f97d42243bad5fab37ca0427f495c86d5b1a18 # v1

      - name: Publish syn-canon when its version is new
        run: |
          version="$(cargo metadata --no-deps --format-version 1 | jq -r '.packages[] | select(.name == "syn-canon") | .version')"
          if curl -sf https://index.crates.io/sy/n-/syn-canon | jq -e --arg v "$version" 'select(.vers == $v)' > /dev/null; then
            echo "syn-canon $version is already on crates.io"
          else
            cargo publish --locked -p syn-canon
          fi
        env:
          CARGO_REGISTRY_TOKEN: ${{ steps.auth.outputs.token }}

      - name: Publish crate
        run: cargo publish --locked -p dejadoc
        env:
          CARGO_REGISTRY_TOKEN: ${{ steps.auth.outputs.token }}

  create-release:
    name: Create the GitHub release
    needs: ci
    runs-on: ubuntu-latest
    permissions:
      contents: write
    steps:
      - name: Create or reuse the release
        env:
          GH_TOKEN: ${{ github.token }}
        run: |
          gh release create "$GITHUB_REF_NAME" --repo "$GITHUB_REPOSITORY" \
            --verify-tag --generate-notes --title "$GITHUB_REF_NAME" \
            || gh release view "$GITHUB_REF_NAME" --repo "$GITHUB_REPOSITORY" >/dev/null

  # Binaries are best effort and independent of publish. A failed target never blocks the
  # crate release, the action falls back to source for a missing asset, and re-running the
  # target completes the release because upload is idempotent.
  binaries:
    name: Build ${{ matrix.target }}
    needs: create-release
    permissions:
      contents: write
    strategy:
      fail-fast: false
      matrix:
        # Keep this target list in sync with the platform case in action.yml.
        include:
          - target: x86_64-unknown-linux-gnu
            os: ubuntu-latest
          - target: aarch64-unknown-linux-gnu
            os: ubuntu-24.04-arm
          - target: x86_64-apple-darwin
            os: macos-latest
          - target: aarch64-apple-darwin
            os: macos-latest
          - target: x86_64-pc-windows-msvc
            os: windows-latest
    runs-on: ${{ matrix.os }}
    steps:
      - name: Checkout
        uses: actions/checkout@fbc6f3992d24b796d5a048ff273f7fcc4a7b6c09 # v5

      - name: Install stable toolchain
        uses: dtolnay/rust-toolchain@6bed0761d98439e5a578e2877258200ad565ba87 # stable
        with:
          toolchain: stable
          targets: ${{ matrix.target }}

      - name: Build the binary
        run: cargo build --release --locked --bin cargo-dejadoc --target ${{ matrix.target }}

      - name: Package and upload the binary
        shell: bash
        env:
          GH_TOKEN: ${{ github.token }}
        run: |
          set -euo pipefail
          bin=cargo-dejadoc
          [ "$RUNNER_OS" = "Windows" ] && bin=cargo-dejadoc.exe
          asset="cargo-dejadoc-${{ matrix.target }}.tar.gz"
          tar -czf "$asset" -C "target/${{ matrix.target }}/release" "$bin"
          gh release upload "$GITHUB_REF_NAME" "$asset" --repo "$GITHUB_REPOSITORY" --clobber