update github action docs to match ambient-action v2#1244
update github action docs to match ambient-action v2#1244vishsanghishetty wants to merge 1 commit intoambient-code:mainfrom
Conversation
the docs were pinned to v0.0.2 and missing several inputs/outputs that have been added since. syncs the inputs table (adds session-name, stop-on-run-finished, poll-timeout), outputs table (adds session-url), fixes the timeout description, and bumps all examples to @v2. closes ambient-code#1232 Signed-off-by: Vishali <vsanghis@redhat.com>
|
Warning Rate limit exceeded
Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 2 minutes and 6 seconds. ⌛ 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. ℹ️ Review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
✨ Finishing Touches🧪 Generate unit tests (beta)
✨ Simplify code
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 |
1 participant
Closes #1232
Why
The GitHub Action docs were pinned to
v0.0.2and hadn't been updated since. Several inputs, an output, and thetimeoutsemantics have all changed inambient-code/ambient-action— the docs didn't reflect any of it.What changed
Inputs table
session-namestop-on-run-finishedpoll-timeoutwait: true)timeoutaction.yml)api-token,project,prompt,wait,poll-interval— aligned wording withaction.ymlOutputs table
session-urlVersion refs
@v0.0.2→@v2(acrossgithub-action.mdandbugfix.md)(v0.0.2)from the intro paragraphFiles touched
docs/src/content/docs/extensions/github-action.mddocs/src/content/docs/workflows/bugfix.mdHow I tested
Compared every input and output in the updated docs against
action.ymlline by line — all 17 inputs and 5 outputs match. No code changes, so no lint/test/tsc applicable. Astro build will run in CI (couldn't build locally — needs Node 22+, local is Node 20).