Reusable GitHub Actions and workflows for PHP applications and Composer libraries. Install dependencies, lint, test, generate API documentation, and publish GitHub releases with Conventional Commit version planning.
Use GitHub.com and Linux runners. Self-hosted runners require GitHub Actions
runner 2.336.0 or newer for native $/ action references. GitHub Enterprise Server
is not supported. Documentation builds require Docker on the runner.
Define project commands in Composer scripts. Start with the CI guide for the default conventions and optional configuration.
- Lint: run Composer lint scripts and report issues.
- Test: run tests, reports and coverage.
- Test a Composer distribution: check the committed source as an installed dependency.
- Get PHP versions: discover stable versions allowed by Composer.
- Setup PHP: install PHP and Composer dependencies.
- Continuous integration: reusable CI inputs and outputs.
- Documentation: generate PHP API documentation for separate deployment.
- Prepare package release: plan a version before validation.
- Release: manual and scheduled Composer releases, configuration and recovery.
- Documentation index: usage and development guides.
See the contributing guidelines and development guide.
MIT. Copyright Hoverkraft.