Skip to content

[cloclo] docs: add FAQ entry for sparse checkout in large monorepos#21655

Merged
pelikhan merged 1 commit intomainfrom
cloclo/faq-sparse-checkout-21630-baa5072cc7270d4c
Mar 18, 2026
Merged

[cloclo] docs: add FAQ entry for sparse checkout in large monorepos#21655
pelikhan merged 1 commit intomainfrom
cloclo/faq-sparse-checkout-21630-baa5072cc7270d4c

Conversation

@github-actions
Copy link
Contributor

Summary

  • Adds a new FAQ question in the Configuration & Setup section: "My workflow checkout is very slow because my repository is a large monorepo. How can I speed it up?"
  • Explains the sparse-checkout field under checkout: frontmatter with code examples
  • Links to the existing Cross-Repository Operations reference for full options

Closes #21630

Test plan

  • Verify the new FAQ entry renders correctly in the docs site
  • Confirm code blocks use the correct yaml wrap fence style
  • Check that the cross-reference link to /gh-aw/reference/cross-repository/ resolves

🤖 Generated with [Claude Code]((claude.com/redacted)

🎤 Magnifique! Performance by /cloclo ·

  • expires on Mar 20, 2026, 9:00 PM UTC

Closes #21630 — adds a Configuration & Setup FAQ entry explaining how
to use checkout.sparse-checkout to speed up workflows on large monorepos.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@pelikhan pelikhan marked this pull request as ready for review March 18, 2026 21:02
Copilot AI review requested due to automatic review settings March 18, 2026 21:02
@pelikhan pelikhan merged commit d5430a2 into main Mar 18, 2026
1 check passed
@pelikhan pelikhan deleted the cloclo/faq-sparse-checkout-21630-baa5072cc7270d4c branch March 18, 2026 21:02
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds documentation to help users speed up slow workflow checkouts in very large monorepos by using checkout.sparse-checkout, with examples and a link to the detailed cross-repo checkout reference.

Changes:

  • Adds a new FAQ entry explaining sparse checkout for large monorepos
  • Includes checkout: frontmatter examples for single and multiple checkout configurations
  • Links readers to Cross-Repository Operations for the full set of checkout options

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

Comment on lines +411 to +420
For cases where you need multiple parts of a monorepo with different settings, you can combine checkouts:

```yaml wrap
checkout:
- sparse-checkout: |
node/my-package
.github
- repository: org/shared-libs
path: ./libs/shared
sparse-checkout: |
github-actions bot added a commit that referenced this pull request Mar 21, 2026
Adds the 🌍 Community Contributions table with 5 confirmed attributions
linking community-labeled issues to their resolving PRs:

- #21630 (@Mossaka) → #21655 sparse-checkout support docs
- #21243 (@holwerda) → #21286 github-app auth in dependencies
- #20299 (@grahame-white) → #20300 fix gh aw upgrade lock files
- #20249 (@mvdbos) → #20301 cross-repo workflow_call validation
- #18480 (@JoshGreenslade) → #21993 GHE Cloud data residency docs

Also flags 241 community-labeled issues as attribution candidates
needing manual review.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Support sparse-checkout in compiled workflows for large monorepos

2 participants