chore(ci): document/add Frontend build (PR) as required status check (closes #377) by cristim · Pull Request #849 · LeanerCloud/cloud-commitments-cli

cristim · 2026-05-28T21:51:44Z

Summary

Adds docs/ci-required-checks.md documenting the canonical required status
checks for feat/multicloud-web-frontend and main, including step-by-step
admin commands (closes chore(ci): add 'Frontend build (PR)' to required status checks on feat/multicloud-web-frontend + main #377).
The API call to add Frontend build (PR) as a required check was attempted
but both branches currently have no protection rule (HTTP 404). Because
creating protection rules from scratch requires repo-admin permissions, the
runbook documents the exact gh api -X PUT command an admin must run.

Admin action required

Neither feat/multicloud-web-frontend nor main has a branch protection
rule yet. A repo-admin must follow docs/ci-required-checks.md Step 3 to
create protection and add Frontend build (PR) to required checks.

Test plan

Admin runs Step 3 commands from docs/ci-required-checks.md
Admin runs Step 4 to verify both branches list Frontend build (PR)
Admin opens a draft PR with a deliberate TS error in frontend/ and
confirms merge is blocked until the check turns green

Summary by CodeRabbit

Release Notes

Documentation
- Added documentation for continuous integration branch protection requirements and setup procedures.

coderabbitai · 2026-05-28T21:51:50Z

Warning

Review limit reached

You’ve reached a temporary PR review limit under our Fair Usage Limits Policy.

Your recent review volume is higher than typical usage, so adaptive limits are currently applied.

Next review available in: 13 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 6277539c-bcb3-4071-add6-427e6dc83775

📥 Commits

Reviewing files that changed from the base of the PR and between ccbafd4 and 8baeef0.

📒 Files selected for processing (1)

docs/ci-required-checks.md

📝 Walkthrough

Walkthrough

A new runbook is added to docs/ci-required-checks.md documenting the required GitHub status check Frontend build (PR) for the CUDly repository. The file provides background context, specifies the check for feat/multicloud-web-frontend and main branches, and includes step-by-step gh api commands to retrieve current checks, patch or create branch protection rules, verify configuration, and run smoke tests.

Changes

CI Required Checks Runbook

Layer / File(s)	Summary
Branch Protection Runbook Documentation `docs/ci-required-checks.md`	Runbook documenting the `Frontend build (PR)` required status check, background on the workflow from PR `#232`, and administrative `gh api` commands to configure, patch, verify, and test branch protection rules on `feat/multicloud-web-frontend` and `main` branches, including `strict` setting notes and UI equivalents.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

LeanerCloud/CUDly#232: Introduced the frontend-build.yml workflow that runs TypeScript type-checking and builds on PRs touching frontend/**; this runbook documents how to enforce that workflow as a required check.

Poem

🐰 A checklist born from the branch-protection trees,
Where Frontend builds must pass with ease,
The runbook hops through gh api commands so true,
Ensuring every PR's TypeScript shines brand-new! ✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Linked Issues check	❓ Inconclusive	The PR adds documentation for the required checks but requires a repo-admin to execute the actual configuration commands. The acceptance criteria (adding the check to both branches and verification) are incomplete without admin action.	Clarify whether this PR is intended solely for documentation/runbook purposes or if acceptance criteria require admin execution before merge. Consider adding a note on required follow-up admin steps.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and concisely summarizes the main change: documenting and adding the 'Frontend build (PR)' required status check, with the issue reference providing additional context.
Out of Scope Changes check	✅ Passed	The changes are scoped to adding documentation (docs/ci-required-checks.md) directly related to issue `#377`'s requirement to document and enable the 'Frontend build (PR)' required check.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch fix/377-wave15

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

cristim · 2026-05-28T21:51:50Z

@coderabbitai review

coderabbitai · 2026-05-28T21:51:57Z

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

cristim · 2026-05-30T10:21:58Z

@coderabbitai full review

coderabbitai · 2026-05-30T10:22:03Z

✅ Actions performed

Full review triggered.

cristim · 2026-06-04T14:03:36Z

@coderabbitai review

coderabbitai · 2026-06-04T14:03:46Z

Rate Limit Exceeded

@cristim have exceeded the limit for the number of chat messages per hour. Please wait 39 minutes and 48 seconds before sending another message.

cristim · 2026-06-06T06:25:05Z

@coderabbitai review

coderabbitai · 2026-06-06T06:25:10Z

✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

cristim · 2026-06-08T08:46:24Z

@coderabbitai full review

coderabbitai · 2026-06-08T08:46:29Z

✅ Action performed

Full review finished.

cristim · 2026-06-19T21:25:11Z

@coderabbitai review

coderabbitai · 2026-06-19T21:25:20Z

✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

cristim · 2026-07-09T21:21:44Z

@coderabbitai review

coderabbitai · 2026-07-09T21:21:53Z

✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

cristim · 2026-07-10T15:13:04Z

@coderabbitai review

coderabbitai · 2026-07-10T15:13:12Z

✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

Both branches are currently unprotected (HTTP 404 on the protection API), so the required-check cannot be added programmatically without repo-admin rights. Add docs/ci-required-checks.md with the exact gh api commands an admin must run to create the protection rule and add "Frontend build (PR)" to required checks on feat/multicloud-web-frontend and main.

… (refs #377) GitHub branch-protection contexts use the job name:, not the workflow name:. The workflow is named 'Frontend build (PR)' but its single job is 'Build frontend', so the context an admin must register is 'Build frontend'. The doc had the wrong string throughout; an admin following it verbatim would add a non-existent context and branch protection would never block a failing frontend build. Also adds a note in the Context section explaining the workflow-name vs job-name distinction so future maintainers understand the correct string to use.

The frontend-build.yml trigger for feat/multicloud-web-frontend was removed when that branch merged into main (commit 4f7d429). The Build frontend check therefore only fires on main-targeting PRs, so branch protection instructions for the retired branch are misleading. Removes the feat/multicloud-web-frontend commands from all four admin steps and the required-checks list; updates the Context section to explain why main is the only active target.

cristim added triaged Item has been triaged priority/p3 Polish / idea / may never ship severity/low Minor harm urgency/eventually No deadline impact/internal Team-internal only effort/xs Trivial / one-liner type/chore Maintenance / non-user-visible labels May 28, 2026

cristim changed the base branch from feat/multicloud-web-frontend to main June 9, 2026 15:44

cristim force-pushed the fix/377-wave15 branch from 07e9353 to 692c665 Compare June 19, 2026 21:23

cristim force-pushed the fix/377-wave15 branch from 692c665 to dbba32e Compare July 10, 2026 15:12

cristim added 3 commits July 17, 2026 21:10

cristim force-pushed the fix/377-wave15 branch from dbba32e to 8baeef0 Compare July 17, 2026 18:11

cristim merged commit 8fb9efd into main Jul 19, 2026
19 checks passed

cristim deleted the fix/377-wave15 branch July 27, 2026 11:09

Conversation

cristim commented May 28, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Admin action required

Test plan

Summary by CodeRabbit

Release Notes

Uh oh!

coderabbitai Bot commented May 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review limit reached

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Poem

❌ Failed checks (1 inconclusive)

Uh oh!

cristim commented May 28, 2026

Uh oh!

coderabbitai Bot commented May 28, 2026

Uh oh!

cristim commented May 30, 2026

Uh oh!

coderabbitai Bot commented May 30, 2026

Uh oh!

cristim commented Jun 4, 2026

Uh oh!

coderabbitai Bot commented Jun 4, 2026

Rate Limit Exceeded

Uh oh!

cristim commented Jun 6, 2026

Uh oh!

coderabbitai Bot commented Jun 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

cristim commented Jun 8, 2026

Uh oh!

coderabbitai Bot commented Jun 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

cristim commented Jun 19, 2026

Uh oh!

coderabbitai Bot commented Jun 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

cristim commented Jul 9, 2026

Uh oh!

coderabbitai Bot commented Jul 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

cristim commented Jul 10, 2026

Uh oh!

coderabbitai Bot commented Jul 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

cristim commented May 28, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented May 28, 2026 •

edited

Loading

coderabbitai Bot commented Jun 6, 2026 •

edited

Loading

coderabbitai Bot commented Jun 8, 2026 •

edited

Loading

coderabbitai Bot commented Jun 19, 2026 •

edited

Loading

coderabbitai Bot commented Jul 9, 2026 •

edited

Loading

coderabbitai Bot commented Jul 10, 2026 •

edited

Loading