Repository navigation
docs(readme): add sparse-clone instructions for contributors - #79
Merged
Merged
Conversation
The qa repo aggregates Allure test results across the Meshery ecosystem; every CI run commits fresh results and regenerated per-PR reports, so a full clone is tens of GB and grows continuously. Document a blobless partial clone + sparse-checkout workflow that excludes the generated test-result and report directories (meshery-results, meshery-server-results, mesheryctl-results, kanvas-results, remote-provider-results, pr-reports) while keeping full history and everything needed to build the dashboard. Includes recipes for a fresh sparse clone, converting an existing full clone, and re-including excluded directories on demand. Signed-off-by: Mia Grenell <184569369+miacycle@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Adds contributor documentation for cloning this repo using a sparse + partial clone workflow to avoid downloading large generated test result/report directories while retaining full history.
Changes:
- Documented which generated directories are safe to exclude from a working tree.
- Added a recommended blobless partial clone +
git sparse-checkoutrecipe. - Added instructions for converting an existing clone and re-including excluded directories.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+97
to
+104
| | Directory | Contents | | ||
| | --- | --- | | ||
| | `meshery-results/` | Raw Allure results for Meshery integration tests | | ||
| | `meshery-server-results/` | Raw Allure results for Meshery Server Go unit tests | | ||
| | `mesheryctl-results/` | Raw Allure results for `mesheryctl` tests | | ||
| | `kanvas-results/` | Raw Allure results for Kanvas (extension) | | ||
| | `remote-provider-results/` | Raw Allure results for the Remote Provider (extension) | | ||
| | `pr-reports/` | Generated per-PR HTML reports (the largest contributor to repo size) | |
| '!/pr-reports/' | ||
|
|
||
| # 3. Populate the working tree | ||
| git checkout master |
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughChangesQA repository clone guidance
Estimated code review effort: 1 (Trivial) | ~5 minutes Suggested reviewers: ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
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
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.
Description
This repo is the QA dashboard's data store: it aggregates Allure test results from across the Meshery ecosystem. Every CI run commits fresh raw results and regenerated per-PR reports, so a full clone is tens of gigabytes and grows continuously - yet almost none of that data is needed to work on the dashboard itself (build scripts, styling, report configuration).
This PR documents a sparse-clone workflow so contributors can clone lean while keeping full commit history and everything required to build the report.
What's added to the README
A new "Cloning this repository (use a sparse clone)" section covering:
meshery-results,meshery-server-results,mesheryctl-results,kanvas-results,remote-provider-results,pr-reports).--filter=blob:none) +git sparse-checkoutexcluding those directories.sparse-checkoutalone would still download the full multi-GB pack; the blob filter is what actually skips the excluded content.git sparse-checkout add) or restoring the full tree (git sparse-checkout disable).Measured impact
git log/blameDocs-only change; no functional impact on the dashboard or its build.
Notes for reviewers
git sparse-checkout); 2.27+ recommended for partial-clone support - noted inline.Summary by CodeRabbit