Skip to content

Commit

Permalink
.github/workflows/pages.yml: build docu with mkdocs and deploy pages
Browse files Browse the repository at this point in the history
Signed-off-by: Tim Janik <[email protected]>
  • Loading branch information
tim-janik committed Jul 18, 2024
1 parent 9ae09e0 commit 08b8fdd
Showing 1 changed file with 59 additions and 0 deletions.
59 changes: 59 additions & 0 deletions .github/workflows/pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# Sample workflow for building and deploying a mdBook site to GitHub Pages
#
# Linting: xclip -sel c <.github/workflows/pages.yml # https://rhysd.github.io/actionlint/
#
name: Deploy site to Pages

on:
# Runs on pushes targeting the default branch
push:
branches: ["trunk"]

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# 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:
# Build job
build:
runs-on: ubuntu-latest
container: { image: 'ghcr.io/tim-janik/anklang-ci:jammy-latest' }
steps:
- name: Checkout Anklang
run: |
pwd && ls -al
rm -rf * .[^.]* ..?*
git clone --recurse-submodules https://github.com/tim-janik/anklang.git .
- name: Setup Pages
id: pages
uses: actions/configure-pages@v5
- run: echo -e 'prefix=/\n CC=clang \n CXX=clang++ \n CLANG_TIDY=clang-tidy ' > config-defaults.mk
- run: make mkdocs -j`nproc`
- run: ls -al out/site/
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./out/site/

# Deployment job
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4

0 comments on commit 08b8fdd

Please sign in to comment.