-
Notifications
You must be signed in to change notification settings - Fork 1
hotfix(ci/docs): deterministic docs rollup check #102
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
- CI: normalize 'Generated:' header lines before diff to avoid false failures on older branches - Docs: record hotfix in execution plan + decision log - Rollup: regenerated (no functional changes)
|
Warning Rate limit exceeded@flyingrobots has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 12 minutes and 3 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (1)
Summary by CodeRabbit
WalkthroughReplaces the previous direct git-diff in the docs rollup CI with a capture‑regenerate‑normalize‑compare flow that normalizes header “Generated:” variants in the top header block before diffing. Adds corresponding hotfix entries to decision-log, echo-total, and execution-plan docs. Changes
Sequence Diagram(s)sequenceDiagram
autonumber
participant GH as GitHub Actions
participant Workspace as Temp Workspace
participant Make as `make echo-total`
participant Norm as Header Normalizer
participant Diff as Normalized Comparator
GH->>Workspace: create temp dir
GH->>Workspace: copy HEAD `docs/echo-total.md` -> `old.md`
GH->>Make: run `make echo-total` (writes `docs/echo-total.md`)
GH->>Workspace: copy regenerated `docs/echo-total.md` -> `new.md`
Workspace->>Norm: normalize header of `old.md` -> `old.norm.md`
Workspace->>Norm: normalize header of `new.md` -> `new.norm.md`
Norm->>Diff: compare `old.norm.md` vs `new.norm.md`
alt files identical
Diff->>GH: exit success
else differences found
Diff->>GH: emit annotated failure, print unified diff, exit failure
end
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes
Possibly related PRs
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (4)
.github/workflows/echo-total-check.yml(1 hunks)docs/decision-log.md(1 hunks)docs/echo-total.md(2 hunks)docs/execution-plan.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/decision-log.md
[uncategorized] ~165-~165: The official name of this software platform is spelled with a capital “H”.
Context: ...fto always differ. - Decision: Update.github/workflows/echo-total-check.yml` to norm...
(GITHUB)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Security Audit
🔇 Additional comments (4)
docs/echo-total.md (2)
532-535: Docs guard entry is clear and scoped.Entry explains normalization and aligns with the workflow change. No action needed.
703-708: Hotfix narrative matches CI behavior.Context/Decision/Consequence read correctly and reference the exact workflow path. Good.
docs/execution-plan.md (1)
305-307: Execution plan note LGTM.Concise, dated (2025-11-02), and consistent with Decision Log. Ship it.
docs/decision-log.md (1)
161-166: Decision entry is precise and reproducible.Date, context, decision, and consequence are explicit and align with the workflow diff. No changes needed.
…otation - Normalize only header-region lines matching ^\s*[Gg]enerated(\s*(:|at:|by:))? to avoid deleting arbitrary content - Add GitHub Actions ::error annotation for clearer diagnostics - Log follow-up in execution plan and decision log - Regenerate rollup
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 3
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (4)
.github/workflows/echo-total-check.yml(1 hunks)docs/decision-log.md(1 hunks)docs/echo-total.md(2 hunks)docs/execution-plan.md(1 hunks)
🧰 Additional context used
🪛 GitHub Actions: Docs Rollup Check
docs/echo-total.md
[error] 1-1: docs/echo-total.md is out of date. Run 'make echo-total' (or scripts/gen-echo-total.sh) and commit the result.
🪛 LanguageTool
docs/decision-log.md
[uncategorized] ~165-~165: The official name of this software platform is spelled with a capital “H”.
Context: ...fto always differ. - Decision: Update.github/workflows/echo-total-check.yml` to norm...
(GITHUB)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Security Audit
🔇 Additional comments (2)
docs/decision-log.md (1)
162-171: Hotfix entry matches the workflow; keep variant lists in sync.Docs list Generated:, generated at:, Generated by:. The CI regex currently matches those; if “Generated on:” ever existed, add it to both docs and CI to avoid drift.
docs/execution-plan.md (1)
305-311: Narrative aligns with the implemented check.Entry accurately describes header-scope normalization and the GitHub annotation behavior.
This hotfix makes the docs rollup CI check deterministic and future-proof.
Why
What changed
Scope
Follow‑ups (optional)