Skip to content

feat(doc): improve builders documentation #4

feat(doc): improve builders documentation

feat(doc): improve builders documentation #4

Workflow file for this run

name: 'Documentation'
on:
push:
branches: ['main']
pull_request:
branches: ['main']
permissions:
contents: 'read'
jobs:
builders-api:
name: 'Builders API'
runs-on: 'ubuntu-latest'
steps:
- uses: 'actions/checkout@v4'
- name: 'Setup PHP'
uses: 'shivammathur/setup-php@v2'
with:
php-version: '8.3'
coverage: 'none'
- name: 'Install dependencies'
uses: 'ramsey/composer-install@v3'
- name: 'Generate builder API doc'
run: 'php ./docs/generate.php'
- name: 'Check documentation'
run: |
if [[ $(git diff --name-only | wc -l) > 0 ]]; then
echo "::error::Builders API documentation is not up to date, please run \"php ./docs/generate.php\""
exit 1
fi