-
Notifications
You must be signed in to change notification settings - Fork 3
Consolidate documentation and optimize CI with Composer caching #333
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
|
Important Review skippedBot user detected. To trigger a single review, invoke the You can disable this status message by setting the Note Other AI code review bot(s) detectedCodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review. Comment |
…aching Co-authored-by: nielsdrost7 <[email protected]>
…ions Co-authored-by: nielsdrost7 <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR consolidates scattered documentation into the .github/ directory, optimizes CI workflows with a reusable composite action for Composer caching, and adds smoke test configuration for faster validation. The changes reduce CI execution time by 6-10 seconds per workflow run through intelligent caching.
- Moved 4 documentation files from root to
.github/for better organization - Created composite action
.github/actions/setup-php-composerwith Composer caching, applied to 6 workflows - Added
phpunit.smoke.xmlconfiguration to run smoke tests filtered by#[Group('smoke')]attribute (17 test files)
Reviewed changes
Copilot reviewed 14 out of 17 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
phpunit.smoke.xml |
New PHPUnit configuration for smoke tests with group filtering |
RUNNING_TESTS.md |
Deleted from root (moved to .github/) |
README.md |
Updated links to reflect documentation moved to .github/ |
CHECKLIST.md |
Deleted from root (moved to .github/) |
.github/workflows/yarn-update.yml |
Replaced manual PHP/Composer setup with composite action |
.github/workflows/release.yml |
Added Composer caching (manual, not using composite action) |
.github/workflows/quickstart.yml |
Replaced manual PHP/Composer setup with composite action |
.github/workflows/pint.yml |
Replaced manual PHP/Composer setup with composite action |
.github/workflows/phpunit.yml |
Replaced manual PHP/Composer setup with composite action |
.github/workflows/phpstan.yml |
Replaced manual PHP/Composer setup with composite action |
.github/workflows/composer-update.yml |
Replaced manual setup with composite action, added smoke test execution |
.github/workflows/README.md |
Added documentation for composite action and updated smoke test section |
.github/actions/setup-php-composer/action.yml |
New reusable composite action for PHP setup with Composer caching |
.github/TEST_GENERATION_SUMMARY.md |
Moved from root, documents PEPPOL test generation |
.github/RUNNING_TESTS.md |
Moved from root with comprehensive rewrite covering all test types |
.github/PEPPOL_TESTS_SUMMARY.md |
Moved from root, documents PEPPOL test coverage |
.github/PEPPOL_ARCHITECTURE.md |
Moved from root, documents PEPPOL e-invoicing architecture |
| **Used by:** | ||
| - `phpunit.yml` - Test execution | ||
| - `phpstan.yml` - Static analysis | ||
| - `pint.yml` - Code formatting | ||
| - `composer-update.yml` - Dependency updates | ||
| - `yarn-update.yml` - Frontend dependency updates | ||
| - `quickstart.yml` - Smoke tests |
Copilot
AI
Jan 1, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The documentation states that the composite action is "Used by" these workflows, but release.yml is not listed and it doesn't actually use the composite action - it only adds caching directly. Either release.yml should be updated to use the composite action, or this list is accurate and doesn't need changing. However, the PR description mentions "Added caching to release.yml" which confirms it doesn't use the composite action.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@copilot apply changes based on this feedback
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This feedback was already addressed in commit 66af3e5. The note has been added on line 34 explaining that release.yml uses manual Composer caching instead of the composite action due to its custom production build flags (--no-dev).
|
@copilot apply changes based on the comments in this thread |
Co-authored-by: nielsdrost7 <[email protected]>
Applied all review feedback in commit 66af3e5:
|
| **Used by:** | ||
| - `phpunit.yml` - Test execution | ||
| - `phpstan.yml` - Static analysis | ||
| - `pint.yml` - Code formatting | ||
| - `composer-update.yml` - Dependency updates | ||
| - `yarn-update.yml` - Frontend dependency updates | ||
| - `quickstart.yml` - Smoke tests |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@copilot apply changes based on this feedback
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.