tektoncd / pipeline

A cloud-native Pipeline resource.
https://tekton.dev
Apache License 2.0
8.49k stars 1.78k forks source link

Rename `ConfigSource` #6350

Closed chuangw6 closed 1 year ago

chuangw6 commented 1 year ago

In v0.42, we introduced a new field Provenance into TaskRun / PipelineRun status to pipe through some data needed for the provenance generation. It's an alpha feature gated by the dedicated feature flag enable-provenance-in-status.

For example, one subfield of it is currently named configSource for recording the source information of the remote task/pipeline definition. But the issue with this naming is that it came from SLSA 0.2 spec. Since SLSA is evolving, we want to change this name to something not specific to SLSA.

chuangw6 commented 1 year ago

Based on the discussion, options are as follows and it seems like TektonSource is preferred.

Just want to surface this to broader audience. If there is no strong objections for the name TektonSource, I'll update the #5831 shortly. Otherwise, please feel free to share if anyone has any idea for the naming.

cc @bobcatfish @Yongxuanzhang @dibyom @wlynch @jagathprakash. Thanks!

wlynch commented 1 year ago

If the original concern was this was a name borrowed from SLSA v0.2, and SLSA v1 isn't using the ConfigSource naming anymore, is this still a problem?

If we still want to rename, my preference would be to use RefProvenance or RefSource, since we're trying to describe the provenance of the resolved source of a ref.

chuangw6 commented 1 year ago

Thanks @wlynch for sharing your thoughts. Great analysis.

I like RefSource!!

(Spec source is indeed confusing in the sense that people might wonder if the spec of SpecSource appearing in a pipelinerun status refers to pipelinerun spec or pipeline spec. )

dibyom commented 1 year ago

RefSource sounds good