Skip to content

docs: a non-running job's cancel emits no job_cancelled #1485

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
brandur merged 2 commits into from
Oct 9, 2026
Merged

docs: a non-running job's cancel emits no job_cancelled #1485

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7077e9c
Document that EventKindJobCancelled fires only for worked jobs
JackDanger Oct 9, 2026
02fbd6c
Clarify cancelled job event documentation
brandur Oct 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion event.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,10 @@ import (
type EventKind string

const (
// EventKindJobCancelled occurs when a job is cancelled.
// EventKindJobCancelled occurs when a client finishes working a job in the
// cancelled state. Cancelling a non-running job with Client.JobCancel or
// Client.JobCancelTx updates it directly without emitting this event;
// inspect the returned JobRow to observe that cancellation.
EventKindJobCancelled EventKind = "job_cancelled"

// EventKindJobCompleted occurs when a job is completed.
Expand Down
Loading