940eb90872* Add API documentation generation with phpDocumentor - Add phpDocumentor configuration and `docs` Makefile target - Generate docs during CI to catch errors before releases - Set up GitHub Pages with Jekyll for hosting generated docs - Add GitHub Actions workflow to deploy docs to GitHub Pages on releases 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * Fix phpDocumentor errors in type annotations Change class-string union types to use phpDocumentor-compatible syntax and reorder docblock tags so class descriptions precede `@author` tags. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * Fix CI: pin phar-io/composer-distributor ^1.0.2 phar-io/composer-distributor 1.0.0 has a bug where it uses the wrong package version when determining the phpDocumentor download URL, causing CI to fail with 404 errors when using --prefer-lowest. Version 1.0.2 fixes this issue. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * Integrate markdown guides into phpDocumentor output Configure phpDocumentor to generate both API documentation and user guides in a single unified site. This replaces the previous Jekyll-based approach where API docs were copied into the docs folder. - Add `<guide>` configuration to `phpdoc.dist.xml` - Create custom template with "Guides" navigation link - Replace `docs/index.html` redirect with `docs/index.md` guide index - Update workflow to publish `build/docs` directly without Jekyll - Track `.phpdoc/template/` while still ignoring `.phpdoc/cache/` 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * Fine-tuning for path, config, and layout --------- Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com> Co-authored-by: Christopher Hertel <mail@christopher-hertel.de>
43 lines
1.1 KiB
Makefile
43 lines
1.1 KiB
Makefile
.PHONY: deps-stable deps-low cs phpstan tests unit-tests inspector-tests coverage ci ci-stable ci-lowest conformance-tests docs
|
|
|
|
deps-stable:
|
|
composer update --prefer-stable
|
|
|
|
deps-low:
|
|
composer update --prefer-lowest
|
|
|
|
cs:
|
|
vendor/bin/php-cs-fixer fix --diff --verbose
|
|
|
|
phpstan:
|
|
vendor/bin/phpstan --memory-limit=-1
|
|
|
|
tests:
|
|
vendor/bin/phpunit
|
|
|
|
unit-tests:
|
|
vendor/bin/phpunit --testsuite=unit
|
|
|
|
inspector-tests:
|
|
vendor/bin/phpunit --testsuite=inspector
|
|
|
|
conformance-tests:
|
|
docker compose -f tests/Conformance/Fixtures/docker-compose.yml up -d
|
|
@echo "Waiting for server to start..."
|
|
@sleep 5
|
|
cd tests/Conformance && npx @modelcontextprotocol/conformance server --url http://localhost:8000/ || true
|
|
docker compose -f tests/Conformance/Fixtures/docker-compose.yml down
|
|
|
|
coverage:
|
|
XDEBUG_MODE=coverage vendor/bin/phpunit --testsuite=unit --coverage-html=coverage
|
|
|
|
ci: ci-stable
|
|
|
|
ci-stable: deps-stable cs phpstan tests
|
|
|
|
ci-lowest: deps-low cs phpstan tests
|
|
|
|
docs:
|
|
vendor/bin/phpdoc
|
|
@grep -q 'No errors have been found' .phpdoc/build/reports/errors.html || \
|
|
(echo "Documentation errors found. See build/docs/reports/errors.html" && exit 1)
|