From 0fe80a6ad15a330716718df699ca52ea1b1110c4 Mon Sep 17 00:00:00 2001
From: Xavier Denis <xldenis@gmail.com>
Date: Fri, 13 Oct 2023 11:21:18 +0200
Subject: [PATCH] Add CI for user guide

---
 .github/workflows/guide-ci.yml | 28 ++++++++++++++++++++++++
 .github/workflows/guide.yml    | 39 ++++++++++++++++++++++++++++++++++
 guide/.gitignore               |  1 +
 guide/book.toml                |  2 +-
 guide/src/SUMMARY.md           |  2 +-
 guide/src/chapter_1.md         |  1 -
 guide/src/quickstart.md        |  1 +
 7 files changed, 71 insertions(+), 3 deletions(-)
 create mode 100644 .github/workflows/guide-ci.yml
 create mode 100644 .github/workflows/guide.yml
 create mode 100644 guide/.gitignore
 delete mode 100644 guide/src/chapter_1.md
 create mode 100644 guide/src/quickstart.md

diff --git a/.github/workflows/guide-ci.yml b/.github/workflows/guide-ci.yml
new file mode 100644
index 000000000..1dfaa340a
--- /dev/null
+++ b/.github/workflows/guide-ci.yml
@@ -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
\ No newline at end of file
diff --git a/.github/workflows/guide.yml b/.github/workflows/guide.yml
new file mode 100644
index 000000000..02240bebf
--- /dev/null
+++ b/.github/workflows/guide.yml
@@ -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
\ No newline at end of file
diff --git a/guide/.gitignore b/guide/.gitignore
new file mode 100644
index 000000000..3006b271d
--- /dev/null
+++ b/guide/.gitignore
@@ -0,0 +1 @@
+book/
diff --git a/guide/book.toml b/guide/book.toml
index f36ee7f1c..6de59f590 100644
--- a/guide/book.toml
+++ b/guide/book.toml
@@ -1,5 +1,5 @@
 [book]
-authors = ["Xavier Denis"]
+authors = ["The Creusot Contributors"]
 language = "en"
 multilingual = false
 src = "src"
diff --git a/guide/src/SUMMARY.md b/guide/src/SUMMARY.md
index 7390c8289..df00cc81a 100644
--- a/guide/src/SUMMARY.md
+++ b/guide/src/SUMMARY.md
@@ -1,3 +1,3 @@
 # Summary
 
-- [Chapter 1](./chapter_1.md)
+- [Quickstart](./quickstart.md)
diff --git a/guide/src/chapter_1.md b/guide/src/chapter_1.md
deleted file mode 100644
index b743fda35..000000000
--- a/guide/src/chapter_1.md
+++ /dev/null
@@ -1 +0,0 @@
-# Chapter 1
diff --git a/guide/src/quickstart.md b/guide/src/quickstart.md
new file mode 100644
index 000000000..acb98436e
--- /dev/null
+++ b/guide/src/quickstart.md
@@ -0,0 +1 @@
+# Quickstart