action.yaml

name: "Coder Agents Chat"
description: "Run Coder agents from any GitHub workflow. Triage issues, review PRs, or follow up on an existing chat."
author: "Coder Technologies Inc. <https://coder.com>"

branding:
  icon: play
  color: gray-dark

inputs:
  chat-prompt:
    description: "Prompt to send to the agents chat. Templated by the workflow before being passed in."
    required: true

  coder-token:
    description: "Coder session token used to authenticate with the Coder API."
    required: true

  coder-url:
    description: "Coder deployment URL."
    required: true

  github-url:
    description: "GitHub issue or pull request URL to link the chat to. Used for the issue/PR comment and as the human-readable association in the chat label."
    required: true

  github-token:
    description: "GitHub token used to post and update issue comments."
    required: true

  coder-organization:
    description: "Coder organization name. Looked up by name to resolve the organization UUID for chat creation. Recommended when the Coder user belongs to more than one organization, since the fallback choice is non-deterministic."
    required: false

  workspace-id:
    description: "Existing workspace ID to pin the chat to. If unset, Agents auto-provisions a workspace."
    required: false

  model-config-id:
    description: "Model configuration ID to use for the chat."
    required: false

  existing-chat-id:
    description: "Existing chat ID to send a follow-up message to instead of creating a new chat. Mutually exclusive with force-new-chat."
    required: false

  comment-on-issue:
    description: "Whether to comment on the GitHub issue or pull request with the chat URL and status."
    required: false
    default: "true"

  wait:
    description: "Wait mode. 'none' (default) returns immediately after creating the chat or sending the message. 'complete' polls every 5 seconds until the chat reaches a terminal status (waiting, completed, error) or wait-timeout-seconds elapses."
    required: false
    default: "none"

  wait-timeout-seconds:
    description: "Maximum seconds to wait when wait=complete before failing with a timeout."
    required: false
    default: "600"

  idempotency-key:
    description: "Optional sharding key to narrow the default reuse scope. By default the action reuses the most recent non-archived chat scoped to `gh-target` and the workflow name (when `GITHUB_WORKFLOW` is set). All chats are owned by the `coder-token` holder, so the scope does not include a per-actor component. Set this to maintain multiple parallel chats on the same target/workflow (for example, one per matrix dimension). Pass the `github.actor` context value to maintain one chat per triggering user."
    required: false

  force-new-chat:
    description: "Always create a new chat instead of reusing the most recent matching chat. Mutually exclusive with existing-chat-id."
    required: false
    default: "false"

outputs:
  coder-username:
    description: "The Coder username the `coder-token` belongs to (always the chat owner; the chats API has no owner override)."

  chat-id:
    description: "The chat ID."

  chat-url:
    description: "The URL to view the chat in Coder."

  chat-created:
    description: "Whether the chat was newly created (true) or a message was sent to an existing chat (false)."

  chat-status:
    description: "Current chat status (waiting, pending, running, paused, completed, error)."

  chat-title:
    description: "The chat title."

  workspace-id:
    description: "The workspace ID the chat is running in (auto-provisioned or provided)."

  pull-request-url:
    description: "URL of the pull request or branch page when the chat has tracked changes."

  pull-request-state:
    description: "Pull request state (open, closed, merged) when available."

  pull-request-title:
    description: "Title of the pull request when available."

  pull-request-number:
    description: "Pull request number when available."

  diff-additions:
    description: "Number of lines added in tracked changes."

  diff-deletions:
    description: "Number of lines deleted in tracked changes."

  diff-changed-files:
    description: "Number of files changed in tracked changes."

  head-branch:
    description: "Head branch name when available."

  base-branch:
    description: "Base branch name when available."

  chat-error-kind:
    description: "Machine-readable error kind when the chat fails (one of `spend_exceeded`, `org_not_found`, `api_error`, `timeout`)."

  chat-error-message:
    description: "Human-readable error message when the chat fails."

runs:
  using: "node20"
  main: "dist/index.js"