Merge pull request #49 from nicholasbishop/bishop-book-split-4

Bishop book split 4
nicholasbishop · Jul 6, 2024 · f5988dd · f5988dd
2 parents 4e4e190 + 432abb9
commit f5988dd
Show file tree

Hide file tree

Showing 4 changed files with 44 additions and 28 deletions.
diff --git a/.github/workflows/book.yml b/.github/workflows/book.yml
@@ -2,13 +2,18 @@ name: Book
 on:
   push:
     branches: [main]
+    tags: ['*']
+  pull_request:
+    branches:
+      - main
+      - version-*
 permissions:
   contents: write
 # Adapted from:
 # https://github.com/rust-lang/mdBook/wiki/Automated-Deployment%3A-GitHub-Actions#github-pages-deploy
 jobs:
   deploy:
-    if: github.repository == 'rust-osdev/uefi-rs'
+    # if: github.repository == 'rust-osdev/uefi-rs'
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
@@ -21,24 +26,39 @@ jobs:
           echo `pwd`/mdbook >> $GITHUB_PATH
       - name: Deploy GitHub Pages
         run: |
-          cd book
-          mdbook build
-          git worktree add gh-pages gh-pages
+          set -x
+
+          git branch -a
+
+          # Configure git user so that `git commit` works.
           git config user.name "Deploy from CI"
           git config user.email ""
-          cd gh-pages
+
+          # Get the highest `uefi` release tag.
+          highest_tag="$(git tag --list | grep uefi-v | sort -V | tail -1)"
+
+          # Create worktrees for both the `main` branch and the highest tag.
+          git worktree add --detach wt-main refs/remotes/origin/main
+          git worktree add --detach wt-tag refs/tags/"${highest_tag}"
+
+          # Create a worktree for the `gh-pages` branch.
+          git worktree add wt-gh-pages gh-pages
+
           # Delete the ref to avoid keeping history.
-          git update-ref -d refs/heads/gh-pages
-          # Place the book under a "HEAD" directory so that we can later
-          # add other versions (e.g. "stable" or "v0.17") without breaking
-          # URLs.
-          rm -rf HEAD
-          mv ../book HEAD
-          git add HEAD
-          # Add an index in the root to redirect to HEAD. If we eventually
-          # serve multiple versions, this can be changed to a real index.
-          cp ../head_redirect.html index.html
-          git add index.html
+          git -C wt-gh-pages update-ref -d refs/heads/gh-pages
+
+          # Delete existing book builds.
+          rm -rf wt-gh-pages/HEAD wt-gh-pages/latest-release
+
+          # Build the book for both `main` and the highest tag.
+          mdbook build --dest-dir wt-gh-pages/HEAD wt-main/book
+          mdbook build --dest-dir wt-gh-pages/latest-release wt-tag/book
+
+          # Add an index in the root to redirect to the latest release.
+          cp wt-main/book/redirect.html wt-gh-pages/index.html
+
           # Commit and push.
+          cd wt-gh-pages
+          git add HEAD latest-release index.html
           git commit -m "Deploy $GITHUB_SHA to gh-pages"
           git push --force
diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml
@@ -5,10 +5,6 @@ on:
     branches:
       - main
       - version-*
-  pull_request:
-    branches:
-      - main
-      - version-*
   schedule:
     - cron: '0 0 * * 0-6'
 env:

diff --git a/book/head_redirect.html b/book/head_redirect.html
diff --git a/book/redirect.html b/book/redirect.html
@@ -0,0 +1,8 @@
+<!DOCTYPE html>
+<head>
+<meta charset="utf-8">
+<title>Redirecting to latest release documentation</title>
+<meta http-equiv="refresh" content="0; URL=latest-release">
+</head>
+
+Redirecting to <a href="latest-release">./latest-release</a>...