.github/workflows/doc-automation.yml #1219
Workflow file for this run
This file contains 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
on: | |
push: | |
branches: | |
- master | |
merge_group: | |
jobs: | |
build_docs_job: | |
runs-on: ubuntu-20.04 | |
permissions: | |
# Grant write permission here so that the doc can be pushed to gh-pages branch | |
contents: write | |
steps: | |
- name: Setup Python 3.9 | |
uses: actions/setup-python@v5 | |
with: | |
python-version: 3.9 | |
architecture: x64 | |
- name: Checkout | |
uses: actions/checkout@v3 | |
- name: Install Dependencies | |
run: | | |
pip install -r ./docs/sphinx/requirements.txt | |
- name: Build the docset | |
run: | | |
cd ./docs/sphinx | |
make html | |
id: build | |
- name: Deploy | |
uses: JamesIves/github-pages-deploy-action@releases/v3 | |
with: | |
ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
BRANCH: gh-pages # The branch the action should deploy to. | |
FOLDER: docs/sphinx/build/html | |
CLEAN_EXCLUDE: '["_config.yml"]' | |
- name: Open issue on failure | |
if: ${{ failure() && github.event_name == 'schedule' }} | |
uses: dacbd/create-issue-action@v1 | |
with: | |
token: ${{ secrets.GITHUB_TOKEN }} | |
title: Doc automation failed | |
body: Commit ${{ github.sha }} daily scheduled [CI run](https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}) failed, please check why | |
assignees: '' |