Merge pull request #128 from DuskSystems/127-add-docs-preview-via-git…

…hub-pages

Deploy rustdocs to GitHub Pages on main

.github/workflows/benchmarks.yml

@@ -9,8 +9,8 @@ on:
       - "**/*.rs"
 
 permissions:
-  id-token: write
   contents: read
+  id-token: write
 
 concurrency:
   group: "${{ github.workflow }}-${{ github.ref }}"

.github/workflows/ci.yml

@@ -9,8 +9,8 @@ on:
       - "**/*.rs"
 
 permissions:
-  id-token: write
   contents: read
+  id-token: write
 
 concurrency:
   group: "${{ github.workflow }}-${{ github.ref }}"

.github/workflows/coverage.yml

@@ -9,8 +9,8 @@ on:
       - "**/*.rs"
 
 permissions:
-  id-token: write
   contents: read
+  id-token: write
 
 concurrency:
   group: "${{ github.workflow }}-${{ github.ref }}"

.github/workflows/docs.yml

@@ -0,0 +1,70 @@
+name: docs
+
+on:
+  push:
+    branches: [main]
+    paths:
+      - "**/*.rs"
+
+permissions:
+  contents: read
+  id-token: write
+  pages: write
+
+concurrency:
+  group: "${{ github.workflow }}-${{ github.ref }}"
+  cancel-in-progress: true
+
+env:
+  SCCACHE_GHA_ENABLED: "true"
+  SCCACHE_GHA_VERSION: "1"
+
+jobs:
+  docs:
+    runs-on: ubuntu-22.04
+    defaults:
+      run:
+        shell: nix develop .#docs --command bash {0}
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Install Nix
+        uses: DeterminateSystems/nix-installer-action@v13
+
+      - name: Setup Nix cache
+        uses: DeterminateSystems/magic-nix-cache-action@v7
+
+      - name: Configure SCCache
+        uses: actions/github-script@v7
+        with:
+          script: |
+            core.exportVariable('ACTIONS_CACHE_URL', process.env.ACTIONS_CACHE_URL);
+            core.exportVariable('ACTIONS_RUNTIME_TOKEN', process.env.ACTIONS_RUNTIME_TOKEN);
+
+      - name: Initialize Nix shell
+        run: nix develop .#docs
+
+      - name: Build docs
+        run: cargo doc --no-deps
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: target/doc/wayfind
+          retention-days: 30
+
+      - name: Show SCCache stats
+        if: always() && !cancelled()
+        run: sccache --show-stats
+
+  deploy:
+    needs: docs
+    runs-on: ubuntu-22.04
+    environment:
+      name: github-pages
+      url: "${{ steps.deployment.outputs.page_url }}"
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/msrv.yml

@@ -9,8 +9,8 @@ on:
       - "**/*.rs"
 
 permissions:
-  id-token: write
   contents: read
+  id-token: write
 
 concurrency:
   group: "${{ github.workflow }}-${{ github.ref }}"

flake.nix

@@ -73,39 +73,39 @@
           ];
         };
 
-        # nix develop .#ci
-        ci = pkgs.mkShell {
-          name = "wayfind-ci-shell";
+        # nix develop .#benchmarks
+        benchmarks = pkgs.mkShell {
+          name = "wayfind-benchmarks-shell";
 
           RUSTC_WRAPPER = "${pkgs.sccache}/bin/sccache";
           CARGO_INCREMENTAL = "0";
 
           buildInputs = with pkgs; [
             # Rust
-            (pkgs.rust-bin.stable."1.80.1".minimal.override {
-              extensions = [
-                "clippy"
-                "rustfmt"
-              ];
-            })
+            (pkgs.rust-bin.stable."1.80.1".minimal)
             sccache
+
+            # Benchmarks
+            cargo-codspeed
           ];
         };
 
-        # nix develop .#benchmarks
-        benchmarks = pkgs.mkShell {
-          name = "wayfind-benchmarks-shell";
+        # nix develop .#ci
+        ci = pkgs.mkShell {
+          name = "wayfind-ci-shell";
 
           RUSTC_WRAPPER = "${pkgs.sccache}/bin/sccache";
           CARGO_INCREMENTAL = "0";
 
           buildInputs = with pkgs; [
             # Rust
-            (pkgs.rust-bin.stable."1.80.1".minimal)
+            (pkgs.rust-bin.stable."1.80.1".minimal.override {
+              extensions = [
+                "clippy"
+                "rustfmt"
+              ];
+            })
             sccache
-
-            # Benchmarks
-            cargo-codspeed
           ];
         };
 
@@ -131,6 +131,20 @@
           ];
         };
 
+        # nix develop .#docs
+        docs = pkgs.mkShell {
+          name = "wayfind-docs-shell";
+
+          RUSTC_WRAPPER = "${pkgs.sccache}/bin/sccache";
+          CARGO_INCREMENTAL = "0";
+
+          buildInputs = with pkgs; [
+            # Rust
+            (pkgs.rust-bin.stable."1.80.1".minimal)
+            sccache
+          ];
+        };
+
         # nix develop .#fuzz
         fuzz = pkgs.mkShell {
           name = "wayfind-fuzz-shell";

src/lib.rs

@@ -1,3 +1,5 @@
+//! TODO
+
 pub mod constraints;
 pub mod decode;
 pub mod errors;