documentation.md

GitHub Reusable Workflow: Build PHP documentation

---

Overview

Build PHP API documentation with phpDocumentor and upload it for a separate deployment job.

The workflow uses the project's phpDocumentor configuration when present, or documents src/ by default. It puts the generated site in _site/phpdoc/ and uploads _site/. No Composer installation or deployment is performed. Use ci-github-publish deployment actions in the caller to combine API documentation with guides or publish GitHub Pages.

Permissions

• contents: read

Usage

name: Build PHP documentation
on:
  push:
    branches:
      - main
permissions: {}
jobs:
  documentation:
    uses: hoverkraft-tech/ci-github-php/.github/workflows/documentation.yml@7b1303edc25e97da2a297dd285a54cf4b6ae76a1 # 1.1.2
    permissions:
      contents: read
    with:
      # JSON array of Linux runner labels. The runner must support Docker containers.
      # Default: `["ubuntu-latest"]`
      runs-on: '["ubuntu-latest"]'

      # PHP project directory relative to the checkout.
      # Default: `.`
      working-directory: .

Inputs

Workflow Call Inputs

Input	Description	Required	Type	Default
runs-on	JSON array of Linux runner labels. The runner must support Docker containers.	false	string	["ubuntu-latest"]
working-directory	PHP project directory relative to the checkout.	false	string	.

Outputs

Output	Description
artifact-id	Uploaded documentation artifact ID.

Contributing

Contributions are welcome! Please see the contributing guidelines for more details.

License

This project is licensed under the MIT License.

SPDX-License-Identifier: MIT

Copyright © 2026 hoverkraft-tech

For more details, see the license.

---

This documentation was automatically generated by CI Dokumentor.