Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,4 @@
/test-git-versions.php export-ignore
/tests export-ignore
/tools export-ignore
/zensical.toml export-ignore
8 changes: 8 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,11 @@ updates:
- /tools/phpstan
schedule:
interval: monthly

- package-ecosystem: pip
directory: /tools/zensical
schedule:
interval: monthly
groups:
zensical:
patterns: ['*']
76 changes: 76 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
name: Documentation

on:
push:
branches: [ main ]
pull_request:
paths:
- .github/workflows/docs.yml
- CHANGELOG.md
- README.md
- UPGRADE-2.0.md
- doc/**
- tools/zensical/**
- zensical.toml
workflow_dispatch:

permissions:
contents: read

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
# Let a deployment finish: the next one waits.
cancel-in-progress: ${{ github.event_name == 'pull_request' }}

jobs:
build:
name: Build the Documentation
runs-on: ubuntu-24.04
steps:
- name: Checkout Code
uses: actions/checkout@v7
with:
# The site is published: keep the token out of the workspace.
persist-credentials: false

- name: Setup Python
uses: actions/setup-python@v7
with:
python-version: '3.14'
cache: pip
cache-dependency-path: tools/zensical/requirements.txt

- name: Install Zensical
run: pip install -r tools/zensical/requirements.txt

- name: Write the pages
run: python tools/zensical/pages.py

# Strict, as configured in zensical.toml: a broken link or anchor fails.
- name: Build the site
run: zensical build --clean

- name: Upload the site
if: github.ref == 'refs/heads/main'
uses: actions/upload-pages-artifact@v5
with:
path: site

deploy:
name: Deploy to GitHub Pages
if: github.ref == 'refs/heads/main'
needs: build
runs-on: ubuntu-24.04
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Setup Pages
uses: actions/configure-pages@v6

- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v5
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
/.phpunit.cache
/composer.lock
/phpunit.xml
/site/
/var/
/vendor
/git-builds/
436 changes: 218 additions & 218 deletions CHANGELOG.md

Large diffs are not rendered by default.

Loading