docs: add CI trigger map for GitHub Actions workflows - #7445
Conversation
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
WalkthroughAdded CI reference documentation in ChangesContinuous integration documentation
Estimated code review effort: 1 (Trivial) | ~4 minutes Suggested labels: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Warning Review ran into problems🔥 ProblemsErrors were encountered while retrieving linked issues. Errors (1)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Document which event triggers which GitHub Actions workflow, the workflow -> reusable -> composite call graph, and the manual approval gates, in a single .github/README.md. Add a Continuous Integration section to CLAUDE.md that points to it. Claude-Session: https://claude.ai/code/session_013Ai5iqwADTryxoiJRNdhCa
Proposed changes
Adds a single source of truth for CI visibility. Until now there was no document mapping GitHub Actions triggers to workflows — answering "what runs on a PR?" or "what runs on a push to develop?" meant opening and cross-referencing several of the 12 workflow files, plus the GitHub UI for the approval gates.
This PR adds
.github/README.mdwith three sections:environmentapproval gates and the condition under which each fires (these previously lived only in the GitHub UI).It also adds a short Continuous Integration section to
CLAUDE.mdpointing to the map.Scope is deliberately limited to cross-file facts that are not present in any single workflow file (the call graph, the gates, the entrypoint overview), so the document stays low-drift. Per-workflow
on:/branch/path details remain in the YAML as the source of truth. No workflow or action YAML is modified, so check contexts and branch protection are unaffected.Issue(s)
https://rocketchat.atlassian.net/browse/NATIVE-1343
How to test or reproduce
.github/README.mdon GitHub and confirm the Mermaid call graph renders and the workflow links resolve..github/workflows/.Screenshots
N/A — documentation only.
Types of changes
Checklist
Further comments
The document intentionally covers only facts that span multiple files. If it begins to drift from the workflows, a natural follow-up is to generate it from the workflow YAML and fail CI when the checked-in copy is stale.
https://claude.ai/code/session_013Ai5iqwADTryxoiJRNdhCa
Summary by CodeRabbit