This repository was archived by the owner on Dec 18, 2025. It is now read-only.

Adds improved documentation for traits. #127

	name: "Documentation"

	on: # yamllint disable-line rule:truthy
	push:
	branches:
	- "*.x"
	pull_request: null
	workflow_dispatch:
	branches:
	- '*.x'

	jobs:
	build:
	name: "Build Documentation"
	runs-on: "ubuntu-latest"
	steps:
	- name: "Checkout"
	uses: "actions/checkout@v4"

	- name: Setup Node
	uses: actions/setup-node@v4
	with:
	node-version: 22
	cache: npm # or pnpm / yarn

	- name: Install dependencies
	run: npm ci

	- name: Build Usage Docs
	run: npm run docs:build

	- name: Build API Docs
	uses: "phpDocumentor/phpDocumentor@master"
	with:
	target: "build/docs/api"

	- name: Upload GitHub Pages artifact
	uses: actions/upload-pages-artifact@v3.0.1
	if: "${{ github.event_name == 'push' && startsWith(github.ref, 'refs/heads/') && endsWith(github.ref, '.x') }}"
	with:
	path: "build/docs"
	retention-days: 1

	deploy:
	name: "Deploy"
	if: "${{ github.event_name == 'push' && startsWith(github.ref, 'refs/heads/') && endsWith(github.ref, '.x') }}"
	runs-on: "ubuntu-latest"

	# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
	permissions:
	pages: write # to deploy to Pages
	id-token: write # to verify the deployment originates from an appropriate source
	contents: write # to commit the updated documentation to the repository

	# Deploy to the github-pages environment
	environment:
	name: github-pages
	url: ${{ steps.deployment.outputs.page_url }}

	needs: ["build"]
	steps:
	- name: Deploy to GitHub Pages
	id: deployment
	uses: actions/deploy-pages@v4 # or specific "vX.X.X" version tag for this action

Provide feedback