Skip to content

docs: document Jira TaskSpawner fields#1068

Open
zerone0x wants to merge 1 commit intokelos-dev:mainfrom
zerone0x:docs/jira-reference-fields-1061
Open

docs: document Jira TaskSpawner fields#1068
zerone0x wants to merge 1 commit intokelos-dev:mainfrom
zerone0x:docs/jira-reference-fields-1061

Conversation

@zerone0x
Copy link
Copy Markdown
Contributor

What type of PR is this?

/kind docs

What this PR does / why we need it:

Documents the missing Jira TaskSpawner source fields in docs/reference.md so users can configure Jira without reading the API types.

Adds reference rows for:

  • spec.when.jira.baseUrl
  • spec.when.jira.project
  • spec.when.jira.jql
  • spec.when.jira.secretRef.name

Which issue(s) this PR is related to:

Fixes #1061
Also addresses part of #777

Special notes for your reviewer:

Kept this scoped to the field-level reference gap from #1061. Jira secret details already exist in docs/integration.md.

Does this PR introduce a user-facing change?

Document missing Jira TaskSpawner source fields in the API reference.

Copy link
Copy Markdown

@cubic-dev-ai cubic-dev-ai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 1 file

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented Apr 30, 2026

Greptile Summary

This PR adds four previously-undocumented spec.when.jira.* reference rows (baseUrl, project, jql, secretRef.name) to docs/reference.md. The descriptions were verified against internal/source/jira.go and accurately reflect the implementation's auth logic and JQL construction.

Confidence Score: 5/5

This is a documentation-only PR with no code changes; safe to merge.

All four new field descriptions were verified against the jira.go implementation and are accurate. No P0 or P1 issues found.

No files require special attention.

Important Files Changed

Filename Overview
docs/reference.md Adds four missing Jira TaskSpawner field rows (baseUrl, project, jql, secretRef.name) in the correct position before the existing pollInterval row; descriptions are consistent with the jira.go implementation

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A["spec.when.jira config"] --> B["baseUrl\n(required)"]
    A --> C["project\n(required)"]
    A --> D["jql\n(optional)"]
    A --> E["secretRef.name\n(required)"]
    A --> F["pollInterval\n(optional)"]

    D -->|"jql is empty"| G["query: project = PROJECT"]
    D -->|"jql set, no ORDER BY"| H["query: project = PROJECT AND (jql)"]
    D -->|"jql set, with ORDER BY"| I["query: project = PROJECT AND (filter) ORDER BY ..."]

    E --> J["JIRA_TOKEN (required)"]
    E --> K["JIRA_USER (optional)"]
    K -->|"present"| L["Basic auth\n(Jira Cloud)"]
    K -->|"absent"| M["Bearer auth\n(Jira DC/Server)"]
Loading

Reviews (2): Last reviewed commit: "docs: document Jira TaskSpawner fields" | Re-trigger Greptile

Comment thread docs/reference.md
@zerone0x zerone0x force-pushed the docs/jira-reference-fields-1061 branch from 1e139fd to be29a9f Compare May 3, 2026 08:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: Jira source fields nearly absent from reference.md — only pollInterval documented, required fields missing

1 participant