docs: document taskTemplate.metadata and upstreamRepo fields#1128
Merged
Conversation
Add reference entries for spec.taskTemplate.metadata.labels, spec.taskTemplate.metadata.annotations, and spec.taskTemplate.upstreamRepo so users can discover these fields without reading the API source. Co-Authored-By: Claude Opus 4.7 <[email protected]>
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
kelos-bot[bot] has reached the 50-review limit for trial accounts. To continue receiving code reviews, upgrade your plan.
github-actions
Bot
added
needs-triage
needs-kind
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
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
1 participant
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:
Adds reference entries to
docs/reference.mdfor threespec.taskTemplatefields that are implemented and in active use but were undocumented:spec.taskTemplate.metadata.labels— labels merged into spawned Tasks, with Go template variable support. Notes the reservedkelos.dev/taskspawnerlabel.spec.taskTemplate.metadata.annotations— annotations merged into spawned Tasks, with Go template variable support. Notes that source annotations override conflicting user values.spec.taskTemplate.upstreamRepo— upstream repo injected asKELOS_UPSTREAM_REPOinto the agent container; typically auto-derived but can be set explicitly for fork workflows.The
metadatafield already appears inexamples/10-taskspawner-github-webhook/taskspawner.yaml, so this fills a documentation gap users would hit when following that example.Which issue(s) this PR is related to:
Fixes #1126
Special notes for your reviewer:
Documentation-only change. Field semantics were taken from
api/v1alpha1/taskspawner_types.go(TaskTemplateMetadataandUpstreamRepogodoc).Does this PR introduce a user-facing change?
Summary by cubic
Documents the missing TaskSpawner fields
spec.taskTemplate.metadata.labels,spec.taskTemplate.metadata.annotations, andspec.taskTemplate.upstreamRepoindocs/reference.md. Clarifies template variable support, the reservedkelos.dev/taskspawnerlabel and source-annotation precedence, and thatupstreamRepois injected asKELOS_UPSTREAM_REPO(useful for fork workflows).Written for commit f19bdf2. Summary will update on new commits.