docs: Setup site

VorpalBlade · Jul 24, 2024 · 06e923f · 06e923f
1 parent d696300
commit 06e923f
Show file tree

Hide file tree

Showing 2 changed files with 70 additions and 0 deletions.
diff --git a/.github/workflows/site-release.yml b/.github/workflows/site-release.yml
@@ -0,0 +1,56 @@
+name: Website
+
+on:
+  push:
+    tags:
+      - v[0-9]+.*
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+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@v4
+        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
+      - run: mkdir -p target/site/
+      - name: Build Book
+        run: |
+          (cd doc && mdbook build -d ../target/site/book)
+      - name: Add static landing page
+        run: cp -r site/* target/site/
+
+      - name: Install Rust
+        run: rustup update stable && rustup default stable
+      - name: Cache builds
+        uses: Swatinem/[email protected]
+        with:
+          key: website
+      - name: Build Rune API docs
+        run: cargo run --bin konfigkoll_rune -- doc --output target/site/api
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          # Upload book directory
+          path: 'target/site'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
diff --git a/site/index.html b/site/index.html
@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+
+<head>
+    <title>Paketkoll and konfigkoll</title>
+    <!-- Redirect to book -->
+    <meta http-equiv="refresh" content="0; url=book/index.html">
+</head>
+
+<body>
+    <p>Please refer to <a href="book/index.html">the documentation for paketkoll and konfigkoll</a></p>
+</body>
+
+</html>