Skip to content

Add a Spotless page to Get started #11

Add a Spotless page to Get started

Add a Spotless page to Get started #11

Workflow file for this run

name: Documentation
# Adapted from the workflow `zensical new` generates (https://zensical.org/docs/publish-your-site/):
# split into build and deploy so that pull requests are built too, with actions pinned by SHA.
on:
push:
branches:
- main
pull_request:
permissions:
contents: read
concurrency:
group: docs-${{ github.ref }}
cancel-in-progress: ${{ github.event_name == 'pull_request' }}
jobs:
build:
name: build
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
- uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
with:
python-version: "3.14"
- name: Install Zensical
run: pip install -r requirements.txt
# Strict mode fails the build on a broken link or anchor. That check is what makes a pull
# request opened from the "Edit this page" button safe to merge from the browser.
- name: Build the site
run: zensical build --clean --strict
- name: Upload the Pages artifact
if: github.event_name == 'push'
uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5.0.0
with:
path: site
deploy:
name: deploy
if: github.event_name == 'push'
needs: build
runs-on: ubuntu-latest
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- uses: actions/configure-pages@45bfe0192ca1faeb007ade9deae92b16b8254a0d # v6.0.0
- id: deployment
uses: actions/deploy-pages@368f82528645a54fb793d4d04e342629a3f51346 # v5.0.1