Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
43 changes: 42 additions & 1 deletion .docket.example.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
# ── Copying this file ─────────────────────────────────────────────────────────────────────
# Safe to copy: copied verbatim as `.docket.yml`, it behaves exactly like having no file, because
# every active value below is the built-in default. Copy only the keys you want to change.
# For `.docket.local.yml` or the global config, copy only `scope: any layer` keys: the four
# For `.docket.local.yml` or the global config, copy only `scope: any layer` keys: the
# `scope: repo-only` keys are ignored with a warning there.
#
# ── Scope tags ────────────────────────────────────────────────────────────────────────────
Expand Down Expand Up @@ -244,6 +244,47 @@ board:
change_types: [chore, docs, feat, fix, refactor, perf]


# ═══ Tickets ══════════════════════════════════════════════════════════════════════════════

# tickets — the ticket system this repository's changes link to. `provider` names the tool
# (jira, linear, …), `site` names where it lives (tickets.example.com), and `project` names where
# new tickets go. Each is a single line; empty (the default) means not set.
#
# No docket command reads these settings yet, so setting them has no effect today. Linking a
# change to a ticket does not consult them either: the ticket a change links to, and its tool,
# are whatever that change's link records.
#
# What `project` means, and what kind of ticket each tool creates, depends on the tool:
#
# | Tool | `project` means | Ticket types |
# |----------------|------------------|----------------------------------------------|
# | Jira | project | issue type (Story, Task, Bug) |
# | Azure DevOps | project | work item type |
# | GitLab | project | issue type |
# | GitHub Issues | repository | issue type, where the organization has them |
# | Shortcut | team | story type |
# | Linear | team | none (labels) |
# | Asana / Trello | project / board | none |
#
# The `auto` switches name five events: a change is created, its spec is written, its pull
# request opens, its pull request merges, or its results are complete. All are off by default,
# and like the settings above, docket does not act on them yet.
#
# These settings belong to the repository: a value in the global config or `.docket.local.yml` is
# ignored with a warning.
# scope: repo-only (shared-setting guarded)
tickets:
provider: ""
site: ""
project: ""
auto:
change_created: false
spec_written: false
pr_opened: false
pr_merged: false
results_completed: false


# ═══ Agent harnesses & agent models ═══════════════════════════════════════════════════════

# agent_harnesses — which harnesses this repository's dispatch surfaces are installed for. It has
Expand Down
12 changes: 12 additions & 0 deletions docs/reference/config-keys.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,21 @@ Each key has one scope:
| `board.section_order` | `[in-progress, built, blocked, groomed, proposed, deferred]` | any layer | the order of the board's sections |
| `board.sorting.<section>.by` / `.direction` | `updated` / `desc` | any layer | how each board section is sorted |
| `change_types` | `[chore, docs, feat, fix, refactor, perf]` | any layer | the types a change can be classified as |
| `tickets.provider` | `""` (unset) | repo-only | the ticket system this repository's changes link to (jira, linear, …); no effect yet |
| `tickets.site` | `""` (unset) | repo-only | where that ticket system lives; no effect yet |
| `tickets.project` | `""` (unset) | repo-only | where new tickets go (a project, team, repository, or board, by tool); no effect yet |
| `tickets.auto.change_created` | `false` | repo-only | a switch for when a change is created; no effect yet |
| `tickets.auto.spec_written` | `false` | repo-only | a switch for when a change's spec is written; no effect yet |
| `tickets.auto.pr_opened` | `false` | repo-only | a switch for when a change's pull request opens; no effect yet |
| `tickets.auto.pr_merged` | `false` | repo-only | a switch for when a change's pull request merges; no effect yet |
| `tickets.auto.results_completed` | `false` | repo-only | a switch for when a change's results are complete; no effect yet |
| `agent_harnesses` | none | any layer | the dispatch opt-in (below) |
| `agents.<harness>.<agent>.model` / `.effort` | the built-in table | global-only | model and effort pins for docket's agents |

**`tickets`** settings are accepted and checked, but no docket command reads them yet, so setting
them has no effect today. Linking a change to a ticket does not consult them: the ticket a change
links to, and its tool, are whatever that change's link records.

**`agent_harnesses`** opts a repository in to docket's parent-facing dispatch surfaces: the
managed block in `CLAUDE.md` / `AGENTS.md` and, for Cursor, `.cursor/rules/docket-dispatch.mdc`.
It takes `claude`, `codex`, `cursor`, and `opencode`. While it is absent, `docket install` touches
Expand Down
Loading
Loading