Skip to content

docs

docs #284

Workflow file for this run

name: docs
on:
push:
tags:
- "v[0-9]+.[0-9]+.[0-9]+"
- "v[0-9]+.[0-9]+.[0-9]+a[0-9]+"
- "v[0-9]+.[0-9]+.[0-9]+b[0-9]+"
- "v[0-9]+.[0-9]+.[0-9]+rc[0-9]+"
workflow_dispatch:
inputs:
target:
description: "Site to build and deploy"
type: choice
options:
- dev
- main
- dryrun
required: true
default: dryrun
version:
description: 'Version tag X.X.X (required if target is main)'
required: false
schedule:
- cron: "0 13 * * SUN"
defaults:
run:
shell: bash -e {0}
env:
DISPLAY: ":99.0"
jobs:
pixi_lock:
name: Pixi lock
runs-on: ubuntu-latest
steps:
- uses: holoviz-dev/holoviz_tasks/pixi_lock@v0
docs_build:
name: Build Documentation
needs: [pixi_lock]
runs-on: "ubuntu-latest"
timeout-minutes: 120
env:
VERSION: ${{ inputs.version }}
steps:
- name: Validate version
if: ${{ inputs.target == 'main' }}
run: |
if [[ -z "$VERSION" || ! "$VERSION" =~ ^[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
echo "❌ 'version' is required and must match format X.X.X (e.g. 0.11.1) when target is 'main'"
exit 1
fi
- uses: holoviz-dev/holoviz_tasks/pixi_install@v0
with:
environments: docs
- name: Build documentation
run: pixi run -e docs docs-build
- uses: holoviz-dev/holoviz_tasks/docs-publish@v0
with:
s3-url: s3://param.holoviz.org
s3-cloudfront-id: E1795F426SOIBL
s3-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
s3-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
version: ${{ inputs.version }}