docs: add CI section to README and CI configuration guide - #59
Merged
Conversation
Document how to set up GitHub Actions CI for toolbox repositories using the matbox-actions reusable workflows: testing, code analysis, spell checking, the release pipeline, badge behavior, and coverage. Closes #42 Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Contributor
Test Results23 tests 23 ✅ 18s ⏱️ Results for commit a35e2a3. ♻️ This comment has been updated with latest results. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #59 +/- ##
==========================================
+ Coverage 42.02% 43.29% +1.26%
==========================================
Files 59 61 +2
Lines 1468 1522 +54
==========================================
+ Hits 617 659 +42
- Misses 851 863 +12 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Lead with the problems MatBox solves (no package manager, CI report formats, manual packaging) and pair each capability with the concrete command and artifact, replacing the abstract feature list. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Real repositories show MatBox-produced badges, CI runs, and releases live, serving as concrete demonstrations of the toolbox in use. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
MATLAB R2023b+ buildtool tasks can produce JUnit and Cobertura reports, and R2025a integrates toolbox packaging with projects, so 'no standard way' overclaimed. The durable gaps are dependency installation and the per-repository glue, which is what the intro now claims. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Covers the feature merged in #61: project root files declared in MLToolboxInfo.json (default LICENSE) are included in the packaged toolbox. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
One-sentence factual summary, then a problem/solution bullet per capability, with the example repositories as bullets instead of inside a sentence. Drops the duplicate Example Repositories section and the remaining marketing phrasing. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds documentation for setting up GitHub Actions CI in toolbox repositories, and makes the README introduction benefit-oriented.
test-code-workflow,check-code-workflow,codespell-workflow,prepare-release-workflow) with complete input tables, the five-stage release pipeline, custom task wrapper discovery, badge behavior, Codecov setup, and version pinningAll documented inputs and behavior were checked against the actual
matbox-actions@v1workflow and action definitions.Closes #42
🤖 Generated with Claude Code