Agent docs

GitHub Actions

Report every job outcome with the composite action.

Report every outcome

Store the show token as the AUDIOREALITY_TOKEN repository secret. The reporting step must use if: always() so failed and cancelled jobs are audible too.

- name: Report job outcome
  if: always()
  uses: audioreality/report@v1
  with:
    token: ${{ secrets.AUDIOREALITY_TOKEN }}

Defaults

  • Job success maps to ok, failure to fail, and cancellation to warn.
  • The title uses the workflow and ref; the agent uses the workflow name.
  • The summary includes the conclusion, commit subject, and actor.
  • github.run_id is the supersession key and the workflow run is linked.

Inputs

Override status, title, summary,source, agent, run_id, newline-separated links, or details. Setnow: true only when this job should request a Brief.

The action source lives under integrations/github-action. It must be extracted to a public action repository and taggedv1 before the example reference can resolve.