tep: TEP-0157 PipelineRun Display Name#1281
Open
rajnish-jais wants to merge 2 commits into
Open
Conversation
Contributor
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
tekton-robot
added
the
size/L
Revises the stub TEP from tektoncd#1174 (@say5) with a complete design: spec.displayName + status.displayName two-field model, $(params.*) and $(context.pipelineRun.*) substitution via existing ApplyReplacements machinery, write-once status semantics (confirmed by @vdemeester in tektoncd/pipeline#10300), webhook validation with configurable length cap, and client impact for Dashboard and CLI. Fixes tektoncd/pipeline#10300
rajnish-jais
force-pushed
the
tep-0157-pipelinerun-displayname
branch
from
June 23, 2026 18:00
36b1e4b to
22ade67
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
2 participants
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.
Summary
Revises the stub TEP from #1174 (@say5) with a complete design for
PipelineRun.spec.displayName/status.displayName.What changed from #1174
@say5's original PR had the right framing but placeholder content ("To be determined") throughout Design Details, Test Plan, Drawbacks, and Alternatives. This revision fills all of those in, incorporating the design discussion on tektoncd/pipeline#10300.
Design highlights
spec.displayName(user-authored template) +status.displayName(reconciler-resolved value clients read). MirrorsPipelineTask.displayNameexactly — no new mental model for authors.$(params.*)and$(context.pipelineRun.{name,namespace,uid})— reuses existingApplyReplacements+GetContextReplacementscall paths (apply.go:391–394, 478).$(tasks.*)/$(results.*)scoped out in v1 since the label should be visible from list-view time, before tasks run.max-pipelinerun-display-name-lengthfeature flag (same pattern asmax-result-size).$(tasks.*)/$(results.*)inspec.displayNamerejected at admission.status.displayNamewhen non-empty; CLI (tkn pr list/tkn pr describe) surfaces it as a column/header;metadata.nameremains the primary identifier for commands liketkn pr logs.ApplyReplacements(existing behavior); reconciler additionally emits aWarningevent with reasonUnresolvedDisplayNameVariable.Motivation
Primary use case is JenkinsX/Lighthouse: Lighthouse injects dynamic data (PR number, branch, SHA) only into
spec.params, not into arbitrary spec fields. A literal-onlyspec.displayName(the earlier proposal in tektoncd/pipeline#10300) can't produce"Build for PR #123"for Lighthouse users. With$(params.PULL_NUMBER)substitution it can.Supersedes
Supersedes #1174. @say5 has been unresponsive since the June 2026 rebase request; they are credited as original author in the frontmatter.
Related