Deploy RFC book (#9)

* feat: add mdBook generation

* ci: deploy RFC book to GitHub Pages

* docs: link to deployed RFC book

Author: PLeVasseur

.github/workflows/deploy.yml

@@ -0,0 +1,46 @@
+name: Deploy
+
+on:
+  push:
+    branches:
+      - main
+
+env:
+  # renovate: datasource=crate depName=mdbook versioning=semver
+  MDBOOK_VERSION: 0.5.3
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+        with:
+          fetch-depth: 0
+      - name: Install mdbook
+        run: |
+          mkdir mdbook
+          curl -Lf https://github.com/rust-lang/mdBook/releases/download/v${{ env.MDBOOK_VERSION }}/mdbook-v${{ env.MDBOOK_VERSION }}-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=./mdbook
+          echo `pwd`/mdbook >> $GITHUB_PATH
+      - name: Generate Book
+        run: |
+          ./generate-book.py
+      - name: Upload Artifact
+        uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5
+        with:
+          path: ./book
+
+  deploy:
+    needs: build
+
+    permissions:
+      pages: write
+      id-token: write
+
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    runs-on: ubuntu-latest
+    steps:
+      - id: deployment
+        uses: actions/deploy-pages@cd2ce8fcbc39b97be8ca5fce6e763baed58fa128 # v5.0.0

.gitignore

@@ -12,3 +12,7 @@ Cargo.lock
 
 # MSVC Windows builds of rustc generate these, which store debugging information
 *.pdb
+
+# Generated by mdBook
+book/
+src/

README.md

@@ -1,4 +1,4 @@
-# Safety-Critical Rust Consortium RFCs
+# Safety-Critical Rust Consortium RFCs - [RFC Book](https://rfcs.arewesafetycriticalyet.org/)
 
 [Safety-Critical Rust Consortium RFCs]: #scrc-rfcs
 

book.toml

@@ -0,0 +1,17 @@
+[book]
+title = "The Safety-Critical Rust Consortium RFC Book"
+
+[output.html]
+smart-punctuation = true
+no-section-label = true
+git-repository-url = "https://github.com/PLeVasseur/safety-critical-rust-consortium-rfcs"
+site-url = "/"
+
+[output.html.search]
+heading-split-level = 0
+
+[output.html.playground]
+runnable = false
+
+[build]
+extra-watch-dirs = ["text"]

generate-book.py

@@ -0,0 +1,52 @@
+#!/usr/bin/env python3
+
+"""
+Generate the mdBook source tree from the RFC repository layout.
+
+This mirrors the rust-lang/rfcs approach: RFCs live under text/, while src/
+is generated just before building the book.
+"""
+
+import os
+import shutil
+import subprocess
+
+
+def main():
+    if os.path.exists("src"):
+        shutil.rmtree("src")
+    os.mkdir("src")
+
+    for path in os.listdir("text"):
+        symlink(f"../text/{path}", f"src/{path}")
+    symlink("../README.md", "src/introduction.md")
+    symlink("../SUBCOMMITTEES.md", "src/subcommittees.md")
+
+    with open("src/SUMMARY.md", "w") as summary:
+        summary.write("[Introduction](introduction.md)\n\n")
+        summary.write("- [Subcommittees](subcommittees.md)\n")
+        collect(summary, "text", 0)
+
+    subprocess.call(["mdbook", "build"])
+
+
+def collect(summary, path, depth):
+    entries = [entry for entry in os.scandir(path) if entry.name.endswith(".md")]
+    entries.sort(key=lambda entry: entry.name)
+    for entry in entries:
+        indent = "    " * depth
+        name = entry.name[:-3]
+        link_path = entry.path[5:]
+        summary.write(f"{indent}- [{name}]({link_path})\n")
+        maybe_subdir = os.path.join(path, name)
+        if os.path.isdir(maybe_subdir):
+            collect(summary, maybe_subdir, depth + 1)
+
+
+def symlink(src, dst):
+    if not os.path.exists(dst):
+        os.symlink(src, dst)
+
+
+if __name__ == "__main__":
+    main()