Skip to content

docs: add CI trigger map for GitHub Actions workflows#7445

Open
diegolmello wants to merge 1 commit into
developfrom
wax-raver
Open

docs: add CI trigger map for GitHub Actions workflows#7445
diegolmello wants to merge 1 commit into
developfrom
wax-raver

Conversation

@diegolmello

@diegolmello diegolmello commented Jun 25, 2026

Copy link
Copy Markdown
Member

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.md with three sections:

  • Entrypoints — the 4 event-triggered workflows, their trigger event, and a one-line summary of what each runs.
  • Call graph — a Mermaid diagram of entrypoint workflows → reusable workflows → composite actions.
  • Manual gates — the 4 GitHub environment approval 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.md pointing 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

  • Open .github/README.md on GitHub and confirm the Mermaid call graph renders and the workflow links resolve.
  • Confirm the entrypoints, call graph, and gates match the current workflow files under .github/workflows/.

Screenshots

N/A — documentation only.

Types of changes

  • Bugfix (non-breaking change which fixes an issue)
  • Improvement (non-breaking change which improves a current function)
  • New feature (non-breaking change which adds functionality)
  • Documentation update (if none of the other choices apply)

Checklist

  • I have read the CONTRIBUTING doc
  • I have signed the CLA
  • Lint and unit tests pass locally with my changes
  • I have added tests that prove my fix is effective or that my feature works (if applicable)
  • I have added necessary documentation (if applicable)
  • Any dependent changes have been merged and published in downstream modules

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

  • Documentation
    • Added a CI overview page describing how key GitHub events map to workflows, including a visual call graph and a list of manual gating conditions.
    • Added a new Continuous Integration section in the main project guidance, pointing readers to the CI overview for workflow triggers and gate details.

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
@diegolmello diegolmello requested a deployment to approve_e2e_testing June 25, 2026 20:39 — with GitHub Actions Waiting
@coderabbitai

coderabbitai Bot commented Jun 25, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 5b8dcbc8-de70-435b-873b-c5d3f77f1f9e

📥 Commits

Reviewing files that changed from the base of the PR and between da389be and 2e2eeef.

📒 Files selected for processing (2)
  • .github/README.md
  • CLAUDE.md
📜 Recent review details
⏰ Context from checks skipped due to timeout. (1)
  • GitHub Check: ESLint and Test / run-eslint-and-test
🧰 Additional context used
🧠 Learnings (1)
📓 Common learnings
Learnt from: CR
Repo: RocketChat/Rocket.Chat.ReactNative

Timestamp: 2026-06-25T20:39:42.204Z
Learning: Before committing, run `pnpm prettier-lint` and `TZ=UTC pnpm test` for the modified files.
Learnt from: CR
Repo: RocketChat/Rocket.Chat.ReactNative

Timestamp: 2026-06-25T20:39:42.204Z
Learning: Pre-commit hooks enforce the project's formatting, linting, and test checks.
Learnt from: CR
Repo: RocketChat/Rocket.Chat.ReactNative

Timestamp: 2026-06-25T20:39:42.204Z
Learning: Read `UBIQUITOUS_LANGUAGE.md` when working in this repository.
Learnt from: CR
Repo: RocketChat/Rocket.Chat.ReactNative

Timestamp: 2026-06-25T20:39:42.204Z
Learning: Use the repository's architecture and subsystem boundaries as described (Redux/Saga state management, React Navigation stacks, WatermelonDB models/schema, SDK/REST API layers, views/containers/theme, i18n, encryption, enterprise code, video conferencing, and VoIP).
🪛 LanguageTool
CLAUDE.md

[uncategorized] ~101-~101: The official name of this software platform is spelled with a capital “H”.
Context: ...gers, call graph, and manual gates: see .github/README.md.

(GITHUB)

🔇 Additional comments (2)
.github/README.md (1)

1-93: LGTM!

CLAUDE.md (1)

99-101: LGTM!


Walkthrough

Added CI reference documentation in .github/README.md covering workflow entrypoints, reusable workflow relationships, and manual gate conditions. CLAUDE.md now links to that CI reference.

Changes

Continuous integration documentation

Layer / File(s) Summary
CI reference page and pointer
.github/README.md, CLAUDE.md
.github/README.md adds CI entrypoints, a call graph, and manual gates; CLAUDE.md adds a pointer to that documentation.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~4 minutes

Suggested labels

type: chore

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the documentation change adding a CI trigger map for GitHub Actions workflows.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

Warning

Review ran into problems

🔥 Problems

Errors were encountered while retrieving linked issues.

Errors (1)
  • NATIVE-1343: Request failed with status code 401

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

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.

1 participant