Skip to content

docs: document the gateway segment in the run identity line - #1028

Merged
edenreich merged 1 commit into
mainfrom
docs/issue-1027-20261026-1350
Oct 26, 2026
Merged

edenreich merged 1 commit into
mainfrom
docs/issue-1027-20261026-1350

Conversation

@inference-gateway-maintainer

Copy link
Copy Markdown
Contributor

Summary

Documents the run identity line that the infer-action bot comment pins, including the new optional Gateway segment.

  • New "Run identity line" subsection in github-action.md, just above "Result comment": it explains that the same line appears in the live cooking comment (above the plan zone) and in the result footer, and describes each segment - Model, Action (linked to the release or commit), CLI, Gateway.
  • Notes how the gateway version is resolved (poll the gateway's /version endpoint, then fall back to the managed OCI image tag or the cached managed binary's --version) and that the segment is omitted when no version can be determined - an external gateway without /version, or a run that finishes before the probe resolves.
  • Updated the rendered result-footer example to the real segment order: Model, Action, CLI, Gateway, View Job, Exit Code, Duration. The previous example was stale - it omitted Action and CLI and placed View Job before the exit code.

Checks: bun run lint:md, bun run format:check, bun run build all pass.

Closes #1027

Co-authored-by: Eden Reich <16985712+edenreich@users.noreply.github.com>
@inference-gateway-releaser

inference-gateway-releaser Bot commented Oct 26, 2026 •

Copy link
Copy Markdown
Contributor

🗑️ Preview environment destroyed.

@edenreich
edenreich merged commit a016726 into main Oct 26, 2026
1 check passed
@edenreich
edenreich deleted the docs/issue-1027-20261026-1350 branch October 26, 2026 13:55
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.

[DOCS] cooking comment now shows the gateway version

1 participant