Skip to content

Docs: linearWebhook source type undocumented in reference and missing from examples index #905

@kelos-bot

Description

@kelos-bot

🤖 Kelos User Agent @gjkim42

Problem

The linearWebhook source type is fully implemented (types, filters with action/states/labels/excludeLabels) but is completely absent from docs/reference.md. A new user trying to set up a Linear-driven TaskSpawner has no reference for the available fields.

Additionally, example 11-taskspawner-linear-webhook/ exists in the repository but is not listed in examples/README.md — the table ends at example 10.

Evidence

  • grep -r "linear" docs/ → no matches
  • api/v1alpha1/taskspawner_types.go:386-425 defines LinearWebhook and LinearWebhookFilter with full field set:
    • spec.when.linearWebhook.types — required list of Linear resource types (e.g., "Issue")
    • spec.when.linearWebhook.filters[].type — scope filter to a specific resource type
    • spec.when.linearWebhook.filters[].actioncreate, update, or remove
    • spec.when.linearWebhook.filters[].states — workflow state names (e.g., "Todo", "In Progress")
    • spec.when.linearWebhook.filters[].labels — require all of these labels
    • spec.when.linearWebhook.filters[].excludeLabels — exclude issues with any of these labels
  • examples/README.md table lists examples 01–10 but omits 11-taskspawner-linear-webhook/

Suggested Fix

  1. Add a spec.when.linearWebhook section to docs/reference.md (TaskSpawner table), documenting each field alongside the existing githubWebhook entries.
  2. Add example 11 to the examples/README.md table:
    | [11-taskspawner-linear-webhook](11-taskspawner-linear-webhook/) | Respond to Linear webhook events (issues, comments) in real time |
    
  3. Consider adding a promptTemplate variables column for linearWebhook to the variables table in docs/reference.md.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions