update README about API token authentication #335
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
name: GitHub Pages | |
on: | |
push: | |
branches: | |
- main | |
- dev | |
pull_request: | |
branches: | |
- main | |
- dev | |
workflow_dispatch: | |
jobs: | |
build-and-deploy: | |
runs-on: ${{ matrix.os }} | |
timeout-minutes: 10 | |
strategy: | |
fail-fast: false | |
matrix: | |
python-version: ["${{ vars.PYTHON_VERSION }}"] | |
os: [ubuntu-latest] | |
steps: | |
- name: Checkout code | |
uses: actions/checkout@v4 | |
- name: Set up Python | |
uses: actions/setup-python@v5 | |
with: | |
python-version: ${{ matrix.python-version }} | |
- name: Run poetry image | |
uses: abatilo/actions-poetry@v3.0.0 | |
with: | |
poetry-version: ${{ vars.POETRY_VERSION }} | |
- name: Install dependencies | |
run: | | |
poetry install --with dev | |
- name: Build docs | |
run: | | |
cd docs | |
poetry run make clean | |
poetry run make html | |
# create distinguished subdirectories for each branch | |
# NOTE: force_orphan will delete all files in the branch (thus main & dev could not be concurrently deployed) | |
- name: Deploy docs main | |
uses: peaceiris/actions-gh-pages@v4 | |
if: github.ref == 'refs/heads/main' || (github.event_name == 'pull_request' && github.base_ref == 'main') | |
with: | |
deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }} | |
publish_dir: ./docs/build/html | |
publish_branch: gh-pages | |
- name: Deploy docs dev | |
uses: peaceiris/actions-gh-pages@v4 | |
if: github.ref == 'refs/heads/dev' || (github.event_name == 'pull_request' && github.base_ref == 'dev') | |
with: | |
deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }} | |
publish_dir: ./docs/build/html | |
destination_dir: dev | |
publish_branch: gh-pages |