docs: document Jira TaskSpawner fields#1068
Open
zerone0x wants to merge 1 commit intokelos-dev:mainfrom
Open
Conversation
Contributor
Greptile SummaryThis PR adds four previously-undocumented Confidence Score: 5/5This 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.
|
| 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)"]
Reviews (2): Last reviewed commit: "docs: document Jira TaskSpawner fields" | Re-trigger Greptile
1e139fd to
be29a9f
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.mdso users can configure Jira without reading the API types.Adds reference rows for:
spec.when.jira.baseUrlspec.when.jira.projectspec.when.jira.jqlspec.when.jira.secretRef.nameWhich 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?