Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Bishop book split 2 #47

Merged
merged 2 commits into from
Jul 6, 2024
Merged

Bishop book split 2 #47

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4f76aa9
book: Publish both main and latest-release versions
nicholasbishop Jul 6, 2024
46ff933
wip
nicholasbishop Jul 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 29 additions & 16 deletions .github/workflows/book.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,14 @@ name: Book
on:
push:
branches: [main]
tags: ['*']
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
Expand All @@ -21,24 +22,36 @@ jobs:
echo `pwd`/mdbook >> $GITHUB_PATH
- name: Deploy GitHub Pages
run: |
cd book
mdbook build
git worktree add gh-pages gh-pages
# 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 main
git worktree add --detach wt-tag "${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
mdbook build --dest-dir wt-gh-pages/latest-release wt-tag

cd wt-gh-pages

# Add an index in the root to redirect to the latest release.
cp ../redirect.html index.html

# Commit and push.
git add HEAD latest-release index.html
git commit -m "Deploy $GITHUB_SHA to gh-pages"
git push --force
8 changes: 0 additions & 8 deletions book/head_redirect.html
View file
Open in desktop

This file was deleted.

8 changes: 8 additions & 0 deletions book/redirect.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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>...