Skip to content

Commit

Permalink
Add CI for user guide
Browse files Browse the repository at this point in the history
  • Loading branch information
xldenis committed Oct 13, 2023
1 parent e23ce64 commit 0fe80a6
Show file tree
Hide file tree
Showing 7 changed files with 71 additions and 3 deletions.
28 changes: 28 additions & 0 deletions .github/workflows/guide-ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: User Guide CI
on: [push, pull_request]
paths:
- guide/**

jobs:
test:
name: Test
runs-on: ubuntu-latest
permissions:
contents: write # To push a branch
pull-requests: write # To create a PR from that branch
steps:
- uses: actions/checkout@master
- name: Install Rust
run: |
rustup set profile minimal
rustup toolchain install stable
rustup default stable
- 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 bin
curl -sSL $url | tar -xz --directory=bin
echo "$(pwd)/bin" >> $GITHUB_PATH
- name: Run tests
run: mdbook test guide
39 changes: 39 additions & 0 deletions .github/workflows/guide.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: Deploy
on:
push:
branches:
- main

jobs:
deploy:
runs-on: ubuntu-latest
permissions:
contents: write # To push a branch
pages: write # To push to a GitHub Pages site
id-token: write # To update the deployment status
steps:
- uses: actions/checkout@v3
with:
fetch-depth: 0
- 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 Book
run: |
# This assumes your book is in the root of your repository.
# Just add a `cd` here if you need to change to another directory.
mdbook build guide
- name: Setup Pages
uses: actions/configure-pages@v2
- name: Upload artifact
uses: actions/upload-pages-artifact@v1
with:
# Upload entire repository
path: 'guide/book'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v1
1 change: 1 addition & 0 deletions guide/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
book/
2 changes: 1 addition & 1 deletion guide/book.toml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[book]
authors = ["Xavier Denis"]
authors = ["The Creusot Contributors"]
language = "en"
multilingual = false
src = "src"
Expand Down
2 changes: 1 addition & 1 deletion guide/src/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Summary

- [Chapter 1](./chapter_1.md)
- [Quickstart](./quickstart.md)
1 change: 0 additions & 1 deletion guide/src/chapter_1.md

This file was deleted.

1 change: 1 addition & 0 deletions guide/src/quickstart.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Quickstart

0 comments on commit 0fe80a6

Please sign in to comment.