Continuous integration
the check on every push, here and in any project
wiki-builder is also a GitHub Action that installs wiki-builder and runs wiki check on a project's
wiki, failing the job on any problem the check reports.[1] What the check refuses is described on
Checks.
Action
A project adds one step after checking out its code, naming a wiki-builder release tag.[1]
# .github/workflows/wiki.yml
name: wiki
on: [push, pull_request]
jobs:
check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: timothymarois/wiki-builder@TAG
| Input | Meaning | Default |
|---|---|---|
root |
the project, relative to the checkout[2] | . |
wiki |
where the wiki lives, relative to the project[2] | docs/wiki |
python-version |
the Python that runs the check, 3.11 or newer[2] | 3.12 |
The action installs the tool from its own copy, at the release named in uses:, so the check that runs is
the one that release ships.[3] A wiki synced against a different release fails, and the check says
to run wiki sync.[4]
Repository workflows
Every push to main and every pull request runs two workflows in the wiki-builder repository, and a push
to main also runs a third that publishes the wiki.[5] One runs the tool's own tests on Python 3.11 and
3.12, against the installed package.[6] Another checks wiki-builder's own wiki with the same action a
project uses, so the action is exercised on every change to it.[7] Publishing that wiki once
it passes is described on Deployment (GitHub).