Skip to content

Add post setup docs #24

Add post setup docs

Add post setup docs #24

Workflow file for this run

---
name: mdbook
on:
push:
branches: [master]
paths:
- 'docs/**'
- 'README.md'
pull_request:
paths:
- 'docs/**'
- 'README.md'
jobs:
build:
runs-on: ubuntu-latest
permissions:
contents: write
if: github.event_name == 'push' && github.ref == 'refs/heads/master'
steps:
- name: Checkout codebase
uses: actions/checkout@v4
- name: Install latest mdbook
run: |
tag=$(curl 'https://api.github.com/repos/rust-lang/mdbook/releases/latest' | jq -r '.tag_name')
url="https://github.com/rust-lang/mdbook/releases/download/${tag}/mdbook-${tag}-x86_64-unknown-linux-gnu.tar.gz"
mkdir mdbook
curl -sSL $url | tar -xz --directory=./mdbook
echo `pwd`/mdbook >> $GITHUB_PATH
- name: Build mdbook
run: |
cd docs
mdbook build
- name: Deploy to GitHub Pages
run: |
git worktree add gh-pages
git config user.name "Deploy from CI"
git config user.email ""
cd gh-pages
# Delete the ref to avoid keeping history.
git update-ref -d refs/heads/gh-pages
rm -rf *
mv ../docs/book/* .
git add .
git commit -m "Deploy $GITHUB_SHA to gh-pages"
git push --force --set-upstream origin gh-pages