Skip to content

Build docs and deploy static content to Pages #11

Build docs and deploy static content to Pages

Build docs and deploy static content to Pages #11

Workflow file for this run

name: Build docs and deploy static content to Pages
on:
push:
branches: ["main"]
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Install prereqs
run: sudo apt install python3-pip pandoc inkscape texlive-latex-extra -y
- name: Pip installs
run: sudo pip install pylatex
- name: Build docs
run: python3 docs-generator.py
- name: Check if docs are generated
run: ls -la
- name: Rename to index.html
run: mv sigmf-spec.html index.html
- name: Setup Pages
uses: actions/configure-pages@v5
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: '.' # Upload entire repository for now, TODO ONLY UPLOAD THE HTML AND PDF IN THE LONG TERM
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4