tools: add doc diff

.github/config/cargo-deny.toml

@@ -11,6 +11,7 @@ ignore = [
 multiple-versions = "deny"
 
 skip-tree = [
+    { name = "docdiff" }, # docdiff is a private crate
     { name = "duvet" }, # duvet is a private crate
     { name = "criterion" }, # criterion is always going to be just a test dependency
     { name = "s2n-quic-integration" }, # s2n-quic-integration is a private crate
@@ -27,7 +28,9 @@ unknown-git = "deny"
 unlicensed = "deny"
 allow-osi-fsf-free = "neither"
 copyleft = "deny"
-confidence-threshold = 0.90
+confidence-threshold = 0.9
+# ignore licenses for private crates
+private = { ignore = true }
 allow = [
     "Apache-2.0",
     "BSD-2-Clause",

.github/workflows/ci.yml

@@ -155,6 +155,47 @@ jobs:
           status: "success"
           url: "${{ steps.s3.outputs.URL }}"
 
+  docdiff:
+    runs-on: ubuntu-latest
+    needs: env
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          submodules: true
+
+      - uses: actions-rs/[email protected]
+        id: toolchain
+        with:
+          # pin to a specific version so we don't get breakage in the generated html
+          toolchain: ${{ needs.env.outputs.msrv }}
+          profile: minimal
+          override: true
+
+      - uses: camshaft/rust-cache@v1
+
+      - name: Clean up cache
+        working-directory: common/docdiff
+        run: rm -f target/release/docdiff
+
+      - name: Cache docdiff
+        uses: actions/[email protected]
+        continue-on-error: true
+        with:
+          path: target/release/docdiff
+          key: ${{ runner.os }}-${{ steps.toolchain.outputs.rustc_hash }}-${{ github.job }}-${{ hashFiles('**/Cargo.lock') }}-${{ hashFiles('common/docdiff/**') }}
+
+      - name: Build docdiff
+        working-directory: common/docdiff
+        run: |
+          if [ ! -f ../../target/release/docdiff ]; then
+            mkdir -p ../../target/release
+            cargo build --release
+            cp target/release/docdiff ../../target/release/docdiff
+          fi
+
+      - name: Run docdiff
+        run: ./target/release/docdiff s2n-quic
+
   test:
     runs-on: ${{ matrix.os }}
     needs: env
@@ -276,6 +317,7 @@ jobs:
       - uses: camshaft/rust-cache@v1
 
       - name: Clean up cache
+        working-directory: common/duvet
         run: rm -f target/release/duvet
 
       - name: Cache duvet
@@ -286,7 +328,13 @@ jobs:
           key: ${{ runner.os }}-${{ steps.toolchain.outputs.rustc_hash }}-${{ github.job }}-duvet-${{ hashFiles('**/Cargo.lock') }}-${{ hashFiles('common/duvet/**') }}
 
       - name: Build duvet
-        run: test -f target/release/duvet || cargo build --bin duvet --release
+        working-directory: common/duvet
+        run: |
+          if [ ! -f ../../target/release/duvet ]; then
+            mkdir -p ../../target/release
+            cargo build --release
+            cp target/release/duvet ../../target/release/duvet
+          fi
 
       - name: Run duvet
         run: ./scripts/compliance ${{ github.sha }}
@@ -498,6 +546,12 @@ jobs:
 
       - uses: camshaft/rust-cache@v1
 
+      - name: Remove api snapshots
+        run: |
+          rm quic/*/api.snap
+          git add .
+          git commit -m 'remove api.snap'
+
       - name: Run cargo insta test
         run: |
           cargo insta test --delete-unreferenced-snapshots

Cargo.toml

@@ -1,6 +1,5 @@
 [workspace]
 members = [
-    "common/duvet",
     "common/s2n-*",
     "quic/s2n-*",
 ]

common/docdiff/Cargo.toml

@@ -0,0 +1,21 @@
+[package]
+name = "docdiff"
+version = "0.1.0"
+authors = ["AWS s2n"]
+edition = "2018"
+license = "Apache-2.0"
+publish = false
+
+[dependencies]
+anyhow = "1"
+duct = "0.13"
+glob = "0.3"
+insta = "1"
+once_cell = "1"
+rayon = "1"
+scraper = "0.12"
+selectors = "0.22"
+structopt = "0.3"
+
+[workspace]
+members = ["."]