Skip to content

Docs Deploy

Docs Deploy #472

Workflow file for this run

name: Docs Deploy
permissions:
contents: write # needed for the deploy step
on:
workflow_run:
workflows: ["Docs Build"]
types: [completed]
branches:
- "main"
jobs:
docs-deploy:
runs-on: ubuntu-latest
if: ${{ github.event.workflow_run.event == 'push' }}
environment:
name: docs-deploy
steps:
- uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
- name: Download Artifact
uses: dawidd6/action-download-artifact@0bd50d53a6d7fb5cb921e607957e9cc12b4ce392 # v12
with:
workflow: docs-build.yml
name: docs-build
path: docs/build/
# Note, the gh-pages deployment requires setting up a SSH deploy key.
# See
# https://github.com/JamesIves/github-pages-deploy-action/tree/dev#using-an-ssh-deploy-key-
- name: Deploy
uses: JamesIves/github-pages-deploy-action@9d877eea73427180ae43cf98e8914934fe157a1a # v4.7.6
with:
folder: docs/build/
ssh-key: ${{ secrets.DEPLOY_KEY }}