pipeline icon indicating copy to clipboard operation
pipeline copied to clipboard

Rename ArrayOrString to ParamValues

Open Yongxuanzhang opened this issue 3 years ago β€’ 7 comments

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 NewParamValues

Yongxuanzhang avatar Aug 10 '22 18:08 Yongxuanzhang

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

tekton-robot avatar Aug 10 '22 18:08 tekton-robot

/test all

Yongxuanzhang avatar Aug 10 '22 18:08 Yongxuanzhang

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

tekton-robot avatar Aug 10 '22 18:08 tekton-robot

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.

Yongxuanzhang avatar Aug 10 '22 19:08 Yongxuanzhang

Gah! Totally missed it! 🀦

Thanks πŸ™

wlynch avatar Aug 10 '22 19:08 wlynch

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.

abayer avatar Aug 11 '22 14:08 abayer

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!

Yongxuanzhang avatar Aug 11 '22 14:08 Yongxuanzhang

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 avatar Aug 11 '22 19:08 tekton-robot

/retest

Yongxuanzhang avatar Aug 11 '22 20:08 Yongxuanzhang

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 avatar Aug 12 '22 15:08 tekton-robot

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 avatar Aug 12 '22 15:08 tekton-robot

[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:

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

tekton-robot avatar Aug 15 '22 18:08 tekton-robot

/lgtm

abayer avatar Aug 16 '22 12:08 abayer

/cc @tektoncd/cli-maintainers we will need to update our usage of ArrayOrString at some point πŸ‘ΌπŸΌ

vdemeester avatar Aug 18 '22 12:08 vdemeester

please make sure to include this kind of notice in the release notes πŸ™

pritidesai avatar Aug 18 '22 22:08 pritidesai