Skip to content

Commit

Permalink
Add a Github workflow that deploys the manual to Github Pages
Browse files Browse the repository at this point in the history
  • Loading branch information
teiesti committed Sep 12, 2024
1 parent c3bb4a8 commit 2127168
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 2 deletions.
5 changes: 3 additions & 2 deletions .github/workflows/mdbook.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
name: Build the manual with mdBook

on:
push:
branches: [ "master" ]
# This is done in mdbook_deploy.yml
# push:
# branches: [ "master" ]
pull_request:
branches: [ "master" ]

Expand Down
49 changes: 49 additions & 0 deletions .github/workflows/mdbook_deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
name: Build the manual with mdBook and deploy it

on:
push:
branches: [ "master" ]

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false

jobs:
deploy:

environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}

runs-on: ubuntu-latest

steps:
- name: Checkout
uses: actions/checkout@v3

- name: Install mdBook
run: |
mkdir -p $HOME/.local/bin/
curl -sSL https://github.com/rust-lang/mdBook/releases/download/v0.4.40/mdbook-v0.4.40-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=$HOME/.local/bin/
- name: Build the manual
run: |
cd res/manual
mdbook build
- name: Upload artifact
uses: actions/upload-pages-artifact@v2
with:
path: './res/manual/book'

- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2

0 comments on commit 2127168

Please sign in to comment.