Skip to content

update github action docs to match ambient-action v2#1244

Open
vishsanghishetty wants to merge 1 commit intoambient-code:mainfrom
vishsanghishetty:docs/1232-update-github-action-docs
Open

update github action docs to match ambient-action v2#1244
vishsanghishetty wants to merge 1 commit intoambient-code:mainfrom
vishsanghishetty:docs/1232-update-github-action-docs

Conversation

@vishsanghishetty
Copy link
Copy Markdown
Contributor

@vishsanghishetty vishsanghishetty commented Apr 7, 2026

Closes #1232


Why

The GitHub Action docs were pinned to v0.0.2 and hadn't been updated since. Several inputs, an output, and the timeout semantics have all changed in ambient-code/ambient-action — the docs didn't reflect any of it.

What changed

Inputs table

Change Detail
Added session-name Send a message to an existing session instead of creating a new one
Added stop-on-run-finished Auto-stop session when the agent finishes its run
Added poll-timeout Max minutes to poll before giving up (when wait: true)
Fixed timeout Was "session timeout in minutes, default 30" → now "inactivity timeout in seconds, default 0" (matches action.yml)
Updated descriptions api-token, project, prompt, wait, poll-interval — aligned wording with action.yml

Outputs table

Change Detail
Added session-url URL to the session in the Ambient UI

Version refs

  • All 4 occurrences of @v0.0.2@v2 (across github-action.md and bugfix.md)
  • Removed hardcoded (v0.0.2) from the intro paragraph

Files touched

File What
docs/src/content/docs/extensions/github-action.md Inputs/outputs tables, version refs, descriptions
docs/src/content/docs/workflows/bugfix.md Version ref in YAML example

How I tested

Compared every input and output in the updated docs against action.yml line 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

  • Documentation
    • Revised GitHub Action documentation with enhanced input and output descriptions for clearer parameter understanding
    • Reorganized documentation structure to improve readability
    • Updated action version references to v2 in all workflow examples

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 7, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 7a4504d7-e925-48a3-a395-b7d38a1e68c5

📥 Commits

Reviewing files that changed from the base of the PR and between 3dd8436 and 205b873.

📒 Files selected for processing (2)
  • docs/src/content/docs/extensions/github-action.md
  • docs/src/content/docs/workflows/bugfix.md

📝 Walkthrough

Walkthrough

Documentation 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

Cohort / File(s) Summary
GitHub Action Documentation
docs/src/content/docs/extensions/github-action.md, docs/src/content/docs/workflows/bugfix.md
Updated action version references from ambient-code/ambient-action@v0.0.5 to ambient-code/ambient-action@v2. Refined input/output descriptions for api-url, api-token, project, timeout, wait, and poll settings. Reordered parameter table rows and updated output terminology from "Name/UID of the created session" to "Created … name/UID."
🚥 Pre-merge checks | ✅ 7 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Title check ⚠️ Warning Title lacks required Conventional Commits format type prefix (feat, fix, chore, docs, refactor, test, ci, perf). Prepend appropriate type prefix; recommend 'docs(github-action):' or 'chore(docs):' to comply with Conventional Commits format.
✅ Passed checks (7 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Linked Issues check ✅ Passed All code changes directly address issue #1232: updated GitHub Action docs to reflect ambient-action v2 inputs, outputs, and version references.
Out of Scope Changes check ✅ Passed Changes are scoped to documentation updates only; no unrelated modifications detected beyond synchronizing docs with ambient-action v2.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Performance And Algorithmic Complexity ✅ Passed Performance and algorithmic complexity check not applicable; pull request contains only Markdown documentation changes with no code modifications.
Security And Secret Handling ✅ Passed Documentation changes contain no hardcoded secrets, tokens, or sensitive credentials. Examples properly use GitHub secret management syntax and input descriptions explicitly instruct users to store sensitive data as GitHub secrets.
Kubernetes Resource Safety ✅ Passed Kubernetes Resource Safety check is not applicable; both modified files are Markdown documentation only, containing no Kubernetes manifests or infrastructure-as-code.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
✨ Simplify code
  • Create PR with simplified 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.

❤️ Share

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

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>
@vishsanghishetty vishsanghishetty force-pushed the docs/1232-update-github-action-docs branch from 5b2c611 to 205b873 Compare April 10, 2026 19:48
@vishsanghishetty
Copy link
Copy Markdown
Contributor Author

@ambient-code

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Our Docs our out of date for the Github action

1 participant