83 lines
2.0 KiB
YAML
83 lines
2.0 KiB
YAML
# Sample workflow for building and deploying a Hugo site to GitHub Pages
|
|
name: Deploy FastVideo Docs to Pages
|
|
|
|
on:
|
|
# Runs on pushes targeting the default branch
|
|
push:
|
|
branches:
|
|
- main
|
|
paths:
|
|
- "docs/**/*.md"
|
|
- "fastvideo/v1/examples/**/*.py"
|
|
pull_request:
|
|
branches:
|
|
- main
|
|
types: [opened, ready_for_review, synchronize, reopened]
|
|
paths:
|
|
- "docs/**/*.md"
|
|
- "fastvideo/v1/examples/**/*.py"
|
|
|
|
# Allows you to run this workflow manually from the Actions tab
|
|
workflow_dispatch:
|
|
|
|
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
|
|
permissions:
|
|
contents: read
|
|
pages: write
|
|
id-token: write
|
|
|
|
# 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
|
|
|
|
# Default to bash
|
|
defaults:
|
|
run:
|
|
shell: bash
|
|
|
|
jobs:
|
|
pre-commit:
|
|
uses: ./.github/workflows/pre-commit.yml
|
|
|
|
# Build job
|
|
build:
|
|
runs-on: ubuntu-latest
|
|
needs: pre-commit
|
|
steps:
|
|
- name: Checkout
|
|
uses: actions/checkout@v4
|
|
- name: Setup Pages
|
|
id: pages
|
|
uses: actions/configure-pages@v5
|
|
- name: Set up Python
|
|
uses: actions/setup-python@v5
|
|
with:
|
|
python-version: "3.10"
|
|
- name: Install dependencies
|
|
run: |
|
|
cd docs
|
|
pip install -r requirements-docs.txt
|
|
- name: Build docs
|
|
run: |
|
|
cd docs
|
|
make clean
|
|
make html
|
|
- name: Upload artifact
|
|
uses: actions/upload-pages-artifact@v3
|
|
with:
|
|
path: ./docs/build/html
|
|
|
|
# Deployment job
|
|
deploy:
|
|
environment:
|
|
name: github-pages
|
|
url: ${{ steps.deployment.outputs.page_url }}
|
|
if: ${{ github.event_name == 'push' }}
|
|
runs-on: ubuntu-latest
|
|
needs: build
|
|
steps:
|
|
- name: Deploy to GitHub Pages
|
|
id: deployment
|
|
uses: actions/deploy-pages@v4 |