Skip to content

Commit

Permalink
add docs build workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
ss2165 committed Jun 17, 2024
1 parent b9d218c commit f7b8b9e
Show file tree
Hide file tree
Showing 2 changed files with 57 additions and 0 deletions.
55 changes: 55 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
name: Build and publish docs

on:
workflow_dispatch:
push:
branches:
- main

# 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.
concurrency:
group: "pages"
cancel-in-progress: true

jobs:
build:
name: Build docs.
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up Python '3.10'
uses: actions/setup-python@v5
with:
python-version: '3.10'
cache: "pip"
- name: Install Tierkreis
run: pip install ."[typecheck]"
- name: Build docs
run: |
cd docs
./build.sh
- name: Upload artifact.
uses: actions/upload-pages-artifact@v3
with:
path: ./docs/build/

publish:
name: Publish docs.
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Setup Pages
uses: actions/configure-pages@v5
- name: Deploy to GitHub Pages.
id: deployment
uses: actions/deploy-pages@v4
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
./venv
tierkreis/core/protos/
*.egg-info/
**/__pycache__/

0 comments on commit f7b8b9e

Please sign in to comment.