add a Justfile, move some scripts to that file

Definitely nicer than having a bunch of scripts lying around.

Author: sunshowers

.github/workflows/ci.yml

@@ -25,12 +25,12 @@ jobs:
         run: cargo clippy --all-features --all-targets
       - name: Lint (rustfmt)
         run: cargo xfmt --check
-      - name: Install cargo readme
+      - name: Install cargo readme and just
         uses: taiki-e/install-action@8484225d9734e230a8bf38421a4ffec1cc249372 # v2
         with:
-          tool: cargo-readme
-      - name: Run cargo readme
-        run: ./scripts/regenerate-readmes.sh
+          tool: cargo-readme,just
+      - name: Generate readmes
+        run: just generate-readmes
       - name: Check for differences
         run: git diff --exit-code
 

.github/workflows/docs.yml

@@ -13,8 +13,9 @@ jobs:
     steps:
       - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
       - uses: dtolnay/rust-toolchain@stable
-      - name: Build rustdocs
-        run: ./scripts/build-docs.sh
+      - uses: taiki-e/install-action@just
+      - name: Build rustdoc
+        run: just rustdoc
       - name: Organize
         run: |
           rm -rf target/gh-pages

Justfile

@@ -0,0 +1,23 @@
+# Print a help message.
+help:
+    just --list
+
+# Build docs for crates and direct dependencies
+rustdoc:
+    @cargo tree --depth 1 -e normal --prefix none --workspace \
+        | gawk '{ gsub(" v", "@", $0); printf("%s\n", $1); }' \
+        | xargs printf -- '-p %s\n' \
+        | RUSTC_BOOTSTRAP=1 RUSTDOCFLAGS='--cfg=doc_cfg' xargs cargo doc --no-deps --lib --all-features
+
+# Generate README.md files from README.tpl and lib.rs files
+generate-readmes:
+    #!/usr/bin/env bash
+    set -eo pipefail
+
+    git ls-files | grep README.tpl$ | while read -r readme; do
+        echo "Generating README for $readme"
+        dir=$(dirname "$readme")
+        cargo readme --project-root "$dir" > "$dir/README.md.tmp"
+        gawk -f "scripts/fix-readmes.awk" "$dir/README.md.tmp" > "$dir/README.md"
+        rm "$dir/README.md.tmp"
+    done

README.tpl

@@ -17,5 +17,5 @@ license](LICENSE-MIT).
 README.md is generated from README.tpl by cargo readme. To regenerate:
 
 cargo install cargo-readme
-./scripts/regenerate-readmes.sh
+just generate-readmes
 -->