update github action docs to match ambient-action v2#1244
Open
vishsanghishetty wants to merge 1 commit intoambient-code:mainfrom
Open
update github action docs to match ambient-action v2#1244vishsanghishetty wants to merge 1 commit intoambient-code:mainfrom
vishsanghishetty wants to merge 1 commit intoambient-code:mainfrom
Conversation
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughDocumentation updates to synchronize GitHub Action documentation with current version. Input/output descriptions clarified, and action version references bumped from v0.0.5 to v2 across examples. Changes
🚥 Pre-merge checks | ✅ 7 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (7 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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 |
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>
5b2c611 to
205b873
Compare
Contributor
Author
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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).Summary by CodeRabbit