Skip to content

Commit

Permalink
Extract docs deployment to a separate workflow and avoid extra steps
Browse files Browse the repository at this point in the history
  • Loading branch information
joined committed Dec 16, 2023
1 parent e911a46 commit 4a1e8e4
Show file tree
Hide file tree
Showing 2 changed files with 57 additions and 20 deletions.
20 changes: 0 additions & 20 deletions .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -162,23 +162,3 @@ jobs:
run: |
cd simulator
pio run --verbose --environment emulator
deploy_docs:
name: Deploy docs via MkDocs
runs-on: ubuntu-latest
if: github.ref == 'refs/heads/main'
steps:
- uses: actions/checkout@v4
- name: Configure Git Credentials
run: |
git config user.name github-actions[bot]
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
- uses: actions/setup-python@v4
with:
python-version: 3.11
cache: 'pip'
- name: Install Python dependencies
run: pip install -r requirements.txt
- run: |
cd mkdocs
mkdocs gh-deploy --force
57 changes: 57 additions & 0 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
name: Deploy MkDocs with GitHub Pages dependencies preinstalled

on:
push:
branches: ['main']

# 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_and_upload:
name: 'Build docs and upload artifact'
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Pages
uses: actions/configure-pages@v4
- name: Setup Python
uses: actions/setup-python@v4
with:
python-version: '3.x'
cache: 'pip'
- name: Install required packages
run: pip install -r requirements.txt
# TODO Maybe cache the `.cache` folder? It doesn't seem to be generated though
- name: Build site
# `_site` directory name is used for Jekyll compatiblity, see https://github.com/actions/upload-pages-artifact/blob/main/action.yml#L12
run: |
cd mkdocs
mkdocs build --config-file ./mkdocs.yml --site-dir ./_site
- name: Upload artifact
uses: actions/upload-pages-artifact@v2

deploy:
name: 'Deploy to GitHub Pages'
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@v3

0 comments on commit 4a1e8e4

Please sign in to comment.