Skip to content

Commit

Permalink
Create gh-pages.yml
Browse files Browse the repository at this point in the history
  • Loading branch information
laceysanderson authored Mar 31, 2024
1 parent 2df7205 commit fdd5ef8
Showing 1 changed file with 52 additions and 0 deletions.
52 changes: 52 additions & 0 deletions .github/workflows/gh-pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
name: Deploy Documentation using MkDocs
on:
push:
branches: ["2.x"]
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
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Pages
uses: actions/configure-pages@v5
- uses: actions/setup-python@v5
with:
python-version: '3.18'
- name: Install Depenendancies
run: pip install mkdocs mkdocs-material
- name: Build Documentation
run: |
cd mkdocs
mkdocs build
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: mkdocs/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 fdd5ef8

Please sign in to comment.