Skip to content

Build experimental docs #36

Build experimental docs

Build experimental docs #36

Workflow file for this run

name: Build experimental docs
on:
push:
branches:
- jcannon/documentation
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: ${{ github.workflow }}
cancel-in-progress: true
jobs:
build_docs:
name: Build Experimental Docs
runs-on: ubuntu-latest
env:
MODE: DEBUG
steps:
- name: Check out code
uses: actions/checkout@v3
with:
repository: thejcannon/pants
ref: jcannon/documentation
- name: Run pants version
run: |
curl --proto '=https' --tlsv1.2 -fsSL https://static.pantsbuild.org/setup/get-pants.sh | bash
pants --version
- name: Convert docs
run: |
yq eval '.site_url = "https://thejcannon.github.io/pants/docs"' -i docs/mkdocs.yml
python docs/convert.py
- name: Build docs
run: |
# Not using Pants because I wanna go Sanic fast
pip install mkdocs mkdocs-material mkdocs-redirects mkdocs-gen-files git+https://github.com/thejcannon/mkdocs-awesome-pages-plugin@1e3502a24f8a6d265fe750a5a711a8d99a9ba811
mkdocs build -f docs/mkdocs.yml
mkdir -p dist/site
mv docs/site dist/site/docs
- name: Setup Pages
uses: actions/configure-pages@v3
- name: Upload artifact
uses: actions/upload-pages-artifact@v2
with:
path: dist/site
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2