Build API docs and Shinylive for GitHub Pages #2692
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
name: Build API docs and Shinylive for GitHub Pages | |
on: | |
workflow_dispatch: | |
push: | |
branches: ["main"] | |
pull_request: | |
merge_group: | |
jobs: | |
build-docs: | |
runs-on: ubuntu-latest | |
strategy: | |
matrix: | |
python-version: ["3.12"] | |
fail-fast: false | |
steps: | |
- uses: actions/checkout@v4 | |
- name: Set up Python ${{ matrix.python-version }} | |
uses: actions/setup-python@v5 | |
with: | |
python-version: ${{ matrix.python-version }} | |
- name: Upgrade pip | |
run: python -m pip install --upgrade pip | |
# ===================================================== | |
# API docs | |
# ===================================================== | |
- name: Install Quarto | |
uses: quarto-dev/quarto-actions/setup@v2 | |
with: | |
version: 1.4.549 | |
- name: Install dependencies | |
run: | | |
cd docs | |
make ../venv | |
make deps | |
- name: Run quartodoc | |
run: | | |
cd docs | |
make quartodoc | |
# ===================================================== | |
# Shinylive | |
# ===================================================== | |
- name: Check out shinylive | |
if: github.ref == 'refs/heads/main' | |
uses: actions/checkout@v4 | |
with: | |
repository: rstudio/shinylive | |
ref: main | |
path: shinylive-repo | |
- name: Update shinylive's copy of shiny and htmltools | |
if: github.ref == 'refs/heads/main' | |
run: | | |
cd shinylive-repo | |
make submodules | |
make submodules-pull-shiny | |
make submodules-pull-htmltools | |
- name: Build shinylive | |
if: github.ref == 'refs/heads/main' | |
run: | | |
cd shinylive-repo | |
make all | |
# TODO-future; Install updated shinylive assets via updated py-shinylive pkg | |
# ===================================================== | |
# Build site | |
# ===================================================== | |
- name: Build site | |
if: ${{ github.ref == 'refs/heads/main' || github.event_name == 'merge_group' || startsWith(github.head_ref, 'docs') }} | |
run: | | |
cd docs | |
make site | |
# ===================================================== | |
# Deploy | |
# ===================================================== | |
- name: Move built API docs and shinylive to single directory | |
if: github.ref == 'refs/heads/main' | |
run: | | |
mkdir deploy | |
mv docs/_site deploy/docs | |
mv shinylive-repo/_shinylive deploy/shinylive | |
- name: Upload site artifact | |
if: github.ref == 'refs/heads/main' | |
uses: actions/upload-pages-artifact@v1 | |
with: | |
path: "deploy" | |
deploy: | |
if: github.ref == 'refs/heads/main' | |
needs: build-docs | |
# Grant GITHUB_TOKEN the permissions required to make a Pages deployment | |
permissions: | |
pages: write # to deploy to Pages | |
id-token: write # to verify the deployment originates from an appropriate source | |
# Deploy to the github-pages environment | |
environment: | |
name: github-pages | |
url: ${{ steps.deployment.outputs.page_url }} | |
# Specify runner + deployment step | |
runs-on: ubuntu-latest | |
steps: | |
- name: Deploy to GitHub Pages | |
id: deployment | |
uses: actions/deploy-pages@v1 |