Skip to content

Document job callbacks and fire and forget bare metal runs - #1064

Draft
epompeii wants to merge 1 commit into
u/ep/callback/githubfrom
u/ep/callback/docs
Draft

epompeii wants to merge 1 commit into
u/ep/callback/githubfrom
u/ep/callback/docs

Conversation

@epompeii

Copy link
Copy Markdown
Member

The docs for callbacks and fire and forget bare metal runs, in all nine languages.

  • bencher run: new chunks for --callback-url, --callback-header, --callback-body, --job, and --ci-callback-token. The body template section gives the five context values, the grammar, and every limit, and says that without a template the callback sends the report. The receiver notes cover dedupe on job.uuid, https only with private addresses refused, the paid plan requirement, and where secrets belong. --detach, --github-actions, and the job wait options point at them. --github-actions says an empty token is refused before the run starts, and --callback-header says to quote the header.
  • GitHub Actions how-to: a fire and forget section with both workflows. It covers the token each workflow takes and why, the check's outcome in every case, the dispatch token's scope, expiry, and rotation, and workflow 2 passing the payload through env:.
  • Server config: the secret_key row says the key also seals pending callbacks, and that changing it drops them.
  • Glossary: Unknown, Callback, and Attach, and the Job entry's states.
  • Changelog: the feature, two breaking changes (a detached GitHub Actions run now needs a callback, and an empty --github-actions token is refused before the run), and the fix that makes a failed or canceled job's check fail instead of pass.

Needed for #1046

Describe --callback-url, --callback-header, --callback-body, --job, and
--ci-callback-token on the bencher run page, point --detach, --github-actions,
and the job wait options at them, and add a fire and forget section with both
workflows to the GitHub Actions how-to, in every language. The --github-actions
option now says an empty token is refused before the run starts.

The secret_key row now says the key also seals pending callbacks, the glossary
gains Unknown, Callback, and Attach, and the changelog gains the feature, its
two breaking changes (the --detach requirement and the empty --github-actions
token), and the failed job check fix.
@epompeii
epompeii marked this pull request as ready for review September 26, 2026 02:44
@epompeii
epompeii added this pull request to stack #1054 September 26, 2026 02:44
@epompeii
epompeii marked this pull request as draft September 26, 2026 03:30
@epompeii
epompeii marked this pull request as ready for review September 26, 2026 04:19
@epompeii
epompeii marked this pull request as draft September 26, 2026 04:27

This branch has not been deployed

No deployments
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.

1 participant