Rename ArrayOrString to ParamValues #5304

Yongxuanzhang · 2022-08-10T18:29:42Z

Changes

This commit fixes issue #4858. With the implementation of Tep75,
ArrayOrString contains object type and it would be confusing if still
use the same name. This commit renames it to ParamValues and type alias
ResultValues to ParamValues. Also use type alias to make sure dependant
libraries can still use ArrayOrString and NewArrayOrString.

/kind cleanup

Submitter Checklist

As the author of this PR, please check off the items in this checklist:

Has Docs included if any changes are user facing
Has Tests included if any functionality added or changed
Follows the commit message standard
Meets the Tekton contributor standards (including
functionality, content, code)
Has a kind label. You can add one by adding a comment on this PR that contains /kind <type>. Valid types are bug, cleanup, design, documentation, feature, flake, misc, question, tep
Release notes block below has been updated with any user facing changes (API changes, bug fixes, changes requiring upgrade notices or deprecation warnings)
Release notes contains the string "action required" if the change requires additional action from users switching to the new release

Release Notes

Rename ArrayOrString to ParamValues, NewArrayOrString to NewStructuredValues

tekton-robot · 2022-08-10T18:29:44Z

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

Yongxuanzhang · 2022-08-10T18:30:04Z

/test all

tekton-robot · 2022-08-10T18:34:03Z

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File	Old Coverage	New Coverage	Delta
pkg/reconciler/pipelinerun/resources/resultrefresolution.go	96.3%	95.4%	-0.9

wlynch

This is going to be a breaking change to downstream clients. Can we use a type alias (example) instead and deprecate the old ArrayOrString type before removing it?

pkg/apis/pipeline/v1/param_types.go

Yongxuanzhang · 2022-08-10T19:12:03Z

This is going to be a breaking change to downstream clients. Can we use a type alias (example) instead and deprecate the old ArrayOrString type before removing it?

Yes I added type alias just under this type:
ArrayOrString = ParamValues
ResultValues = ParamValues
And also for method:
NewArrayOrString = NewStructuredValues

So other libraries shouldn't break.

wlynch · 2022-08-10T19:14:06Z

Gah! Totally missed it! 🤦

Thanks 🙏

wlynch

Let's add a simple test to ensure we don't break existing ArrayOrString compatibility, but otherwise lgtm!

pkg/apis/pipeline/v1/param_types.go

abayer · 2022-08-11T14:37:03Z

I just retitled the PR to start with WIP and marked it as ready for review, so that all the CI jobs launch properly/automatically.

Yongxuanzhang · 2022-08-11T14:42:14Z

I just retitled the PR to start with WIP and marked it as ready for review, so that all the CI jobs launch properly/automatically.

Oh thank you!

pkg/apis/pipeline/v1/param_types.go

pkg/apis/pipeline/v1/result_types.go

tekton-robot · 2022-08-11T19:48:51Z

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File	Old Coverage	New Coverage	Delta
pkg/reconciler/pipelinerun/resources/resultrefresolution.go	95.4%	96.3%	0.9

Yongxuanzhang · 2022-08-11T20:14:00Z

/retest

pkg/apis/pipeline/v1beta1/param_types.go

pkg/apis/pipeline/v1/param_types_test.go

pkg/apis/pipeline/v1beta1/param_conversion.go

tekton-robot · 2022-08-12T15:16:13Z

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File	Old Coverage	New Coverage	Delta
pkg/reconciler/pipelinerun/resources/resultrefresolution.go	95.4%	96.3%	0.9

tekton-robot · 2022-08-12T15:51:51Z

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File	Old Coverage	New Coverage	Delta
pkg/reconciler/pipelinerun/resources/resultrefresolution.go	95.4%	96.3%	0.9

lbernick · 2022-08-15T18:52:01Z

pkg/reconciler/pipelinerun/resources/resultrefresolution.go

@@ -151,12 +151,12 @@ func resolveResultRef(pipelineState PipelineRunState, resultRef *v1beta1.ResultR
 	}

 	var runName, runValue, taskRunName string
-	var resultValue v1beta1.ArrayOrString
+	var resultValue v1beta1.ParamValue


should this be a ResultValue? I think you may be able to cast the return value (not sure). As an aside when we update to go 1.18 we might be able to use generics for that function.

Oh yes! This should be result value. I have went through the ParamValue used in result files again and fix some other places as well

Now they can be used interchangeably due to the type alias.

tekton-robot · 2022-08-15T18:54:10Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: lbernick

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [lbernick]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

This commit fixes issue tektoncd#4858. With the implementation of Tep75, ArrayOrString contains object type and it would be confusing if still use the same name. This commit renames it to ParamValues and type alias ResultValues to ParamValues. Also use type alias to make sure dependant libraries can still use ArrayOrString and NewArrayOrString.

abayer · 2022-08-16T12:45:41Z

/lgtm

vdemeester · 2022-08-18T12:44:51Z

/cc @tektoncd/cli-maintainers we will need to update our usage of ArrayOrString at some point 👼🏼

pritidesai · 2022-08-18T22:44:44Z

please make sure to include this kind of notice in the release notes 🙏

tekton-robot requested review from jerop, vdemeester and wlynch August 10, 2022 18:29

tekton-robot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Aug 10, 2022

wlynch requested changes Aug 10, 2022

View reviewed changes

pkg/apis/pipeline/v1/param_types.go Outdated Show resolved Hide resolved

wlynch reviewed Aug 10, 2022

View reviewed changes

pkg/apis/pipeline/v1/param_types.go Outdated Show resolved Hide resolved

abayer changed the title ~~Rename ArrayOrString to ParamValues~~ WIP: Rename ArrayOrString to ParamValues Aug 11, 2022

abayer marked this pull request as ready for review August 11, 2022 14:36

tekton-robot requested review from lbernick, pritidesai and wlynch August 11, 2022 14:36

Yongxuanzhang force-pushed the rename-arrayorstring branch 2 times, most recently from 32b151b to 2865db4 Compare August 11, 2022 17:51

lbernick reviewed Aug 11, 2022

View reviewed changes

pkg/apis/pipeline/v1/param_types.go Outdated Show resolved Hide resolved

pkg/apis/pipeline/v1/result_types.go Outdated Show resolved Hide resolved

Yongxuanzhang force-pushed the rename-arrayorstring branch 2 times, most recently from 47f0124 to d6b9248 Compare August 11, 2022 21:31

JeromeJu reviewed Aug 12, 2022

View reviewed changes

pkg/apis/pipeline/v1beta1/param_types.go Show resolved Hide resolved

JeromeJu reviewed Aug 12, 2022

View reviewed changes

pkg/apis/pipeline/v1/param_types_test.go Outdated Show resolved Hide resolved

JeromeJu reviewed Aug 12, 2022

View reviewed changes

pkg/apis/pipeline/v1beta1/param_conversion.go Outdated Show resolved Hide resolved

Yongxuanzhang force-pushed the rename-arrayorstring branch 2 times, most recently from 4414b55 to f5fc2de Compare August 12, 2022 15:11

Yongxuanzhang force-pushed the rename-arrayorstring branch from f5fc2de to 156bc30 Compare August 12, 2022 15:46

Yongxuanzhang force-pushed the rename-arrayorstring branch 2 times, most recently from e2028cc to cdd3c13 Compare August 12, 2022 16:18

Yongxuanzhang changed the title ~~WIP: Rename ArrayOrString to ParamValues~~ Rename ArrayOrString to ParamValues Aug 12, 2022

tekton-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Aug 12, 2022

Yongxuanzhang requested review from lbernick and JeromeJu August 15, 2022 17:21

lbernick approved these changes Aug 15, 2022

View reviewed changes

tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Aug 15, 2022

Yongxuanzhang force-pushed the rename-arrayorstring branch from cdd3c13 to cf39802 Compare August 15, 2022 19:10

tekton-robot assigned abayer Aug 16, 2022

tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Aug 16, 2022

tekton-robot merged commit 795e720 into tektoncd:main Aug 16, 2022

lbernick mentioned this pull request Aug 23, 2022

Add a new struct to replace ArrayOrString struct #4858

Closed

jerop mentioned this pull request Aug 24, 2022

Add types and client for Resolution #5200

Merged

7 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Rename ArrayOrString to ParamValues #5304

Rename ArrayOrString to ParamValues #5304

Yongxuanzhang commented Aug 10, 2022 •

edited

Loading

tekton-robot commented Aug 10, 2022

Yongxuanzhang commented Aug 10, 2022

tekton-robot commented Aug 10, 2022

wlynch left a comment

Yongxuanzhang commented Aug 10, 2022 •

edited

Loading

wlynch commented Aug 10, 2022 •

edited

Loading

wlynch left a comment

abayer commented Aug 11, 2022

Yongxuanzhang commented Aug 11, 2022

tekton-robot commented Aug 11, 2022

Yongxuanzhang commented Aug 11, 2022

tekton-robot commented Aug 12, 2022

tekton-robot commented Aug 12, 2022

lbernick Aug 15, 2022

Yongxuanzhang Aug 15, 2022

tekton-robot commented Aug 15, 2022

abayer commented Aug 16, 2022

vdemeester commented Aug 18, 2022

pritidesai commented Aug 18, 2022

Rename ArrayOrString to ParamValues #5304

Rename ArrayOrString to ParamValues #5304

Conversation

Yongxuanzhang commented Aug 10, 2022 • edited Loading

Changes

Submitter Checklist

Release Notes

tekton-robot commented Aug 10, 2022

Yongxuanzhang commented Aug 10, 2022

tekton-robot commented Aug 10, 2022

wlynch left a comment

Choose a reason for hiding this comment

Yongxuanzhang commented Aug 10, 2022 • edited Loading

wlynch commented Aug 10, 2022 • edited Loading

wlynch left a comment

Choose a reason for hiding this comment

abayer commented Aug 11, 2022

Yongxuanzhang commented Aug 11, 2022

tekton-robot commented Aug 11, 2022

Yongxuanzhang commented Aug 11, 2022

tekton-robot commented Aug 12, 2022

tekton-robot commented Aug 12, 2022

lbernick Aug 15, 2022

Choose a reason for hiding this comment

Yongxuanzhang Aug 15, 2022

Choose a reason for hiding this comment

tekton-robot commented Aug 15, 2022

abayer commented Aug 16, 2022

vdemeester commented Aug 18, 2022

pritidesai commented Aug 18, 2022

Yongxuanzhang commented Aug 10, 2022 •

edited

Loading

Yongxuanzhang commented Aug 10, 2022 •

edited

Loading

wlynch commented Aug 10, 2022 •

edited

Loading