Enhanced 'vortex-tooling' package docs and relocated its maintenance guide.#2541
Conversation
WalkthroughThis PR consolidates tooling guidance into ChangesTooling Documentation Reorganization
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
2 similar comments
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2541 +/- ##
==========================================
- Coverage 86.56% 86.11% -0.46%
==========================================
Files 94 87 -7
Lines 4660 4501 -159
Branches 47 3 -44
==========================================
- Hits 4034 3876 -158
+ Misses 626 625 -1 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
2 similar comments
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
2 similar comments
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
|
Code coverage (threshold: 90%) Per-class coverage |
This comment has been minimized.
This comment has been minimized.
2 similar comments
This comment has been minimized.
This comment has been minimized.
|
Code coverage (threshold: 90%) Per-class coverage |
Summary
The
drevops/vortex-toolingpackage'sCLAUDE.mdwas deleted because it shipped to consumer projects and leaked internal maintenance details that have no place on a consumer site. Its content was folded into.vortex/CLAUDE.md(never published to consumers) as a dedicated "Tooling package" section. The packageREADME.mdwas restructured, expanded, and rewritten to address the reader directly: installation comes first, a new "Extending provisioning" section documents the post-provision hook system as the recommended extension point, the "Customisation" section is reframed as a last resort for patching shipped scripts, and a Testing section explains the unit and integration coverage..vortex/README.mdgained a one-line entry recording where the package is deployed.Changes
.vortex/tooling/CLAUDE.md- deleteddrevops/vortex-toolingpackage and exposed internal maintenance notes to every consumer project that installed the dependency..vortex/CLAUDE.md- extendedtooling/has noCLAUDE.mdof its own, and explains why.ahoy test-batsto the Quick Commands block and as a step in the script-update workflow (renumbering the subsequent steps)..vortex/tooling/README.md- restructured, expanded, and rewordedscripts/provision-*.shfiles are discovered and run in filename order by the shippedprovisionscript, illustrated with a project-layout file tree (scripts/,vendor/.../provision,web/, and...), links to the shipped examples, and a link to the provisioning documentation.cweagans/composer-patchesonly when no post-provision hook can achieve the goal - and explained why in-place edits are lost on update..vortex/README.md- one-line additiontoolingentry pointing tohttps://github.com/drevops/vortex-tooling, consistent with the other subsystem entries.Before / After
Summary by CodeRabbit