Docs Deploy #230
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | |
- name: Download Artifact | |
uses: dawidd6/action-download-artifact@07ab29fd4a977ae4d2b275087cf67563dfdf0295 # v9 | |
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@6c2d9db40f9296374acc17b90404b6e8864128c8 # v4.7.3 | |
with: | |
folder: docs/build/ | |
ssh-key: ${{ secrets.DEPLOY_KEY }} |