Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Discussion about disallowing usage of object/array param/result as a whole in format: results.result1 or params.param1 (without star reference) #5078

Closed
ywluogg opened this issue Jul 5, 2022 · 5 comments
Labels
kind/feature Categorizes issue or PR as related to a new feature. lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed.

Comments

@ywluogg
Copy link
Contributor

ywluogg commented Jul 5, 2022

Feature request

In TEP 75 and in the implementation tracker (#5056) we stated that we don't want to support referring objects/array params/results as a whole in format results.result1 or params.param1

Use case

As stated above

@ywluogg ywluogg added the kind/feature Categorizes issue or PR as related to a new feature. label Jul 5, 2022
@ywluogg ywluogg changed the title Invalidate usage of object/array param/result as a whole in format: results.result1 or params.param1 discussion about disallowing usage of object/array param/result as a whole in format: results.result1 or params.param1 Jul 15, 2022
@ywluogg ywluogg changed the title discussion about disallowing usage of object/array param/result as a whole in format: results.result1 or params.param1 Discussion about disallowing usage of object/array param/result as a whole in format: results.result1 or params.param1 Jul 15, 2022
@ywluogg ywluogg changed the title Discussion about disallowing usage of object/array param/result as a whole in format: results.result1 or params.param1 Discussion about disallowing usage of object/array param/result as a whole in format: results.result1 or params.param1 (without star reference) Jul 15, 2022
@ywluogg
Copy link
Contributor Author

ywluogg commented Jul 15, 2022

Offline discussion leads to conclusion that we want to be consistent for referring object and array params and results using [*] for consistency and syntax clearity. That said, currently array params are allowed to be referred using format params.param1, so we need to deprecate this reference format. After deprecation, array and object params and results can only be referenced using [*]. Examples:
results.array-result[*]
params.array-param[*]
results.object-result[*]
params.object-param[*]

@ywluogg
Copy link
Contributor Author

ywluogg commented Jul 20, 2022

Per https://github.com/tektoncd/pipeline/blob/main/api_compatibility_policy.md, we need to add a warning for reference format: params.array-param

@ywluogg
Copy link
Contributor Author

ywluogg commented Aug 2, 2022

After discussion, it seems better that we plan to deprecate the params.paramArray1 as a whole usage, but we don't enforce it in implementation. In doc, we will recommend the star reference to refer param arrays as a whole.

@tekton-robot
Copy link
Collaborator

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale with a justification.
Stale issues rot after an additional 30d of inactivity and eventually close.
If this issue is safe to close now please do so with /close with a justification.
If this issue should be exempted, mark the issue as frozen with /lifecycle frozen with a justification.

/lifecycle stale

Send feedback to tektoncd/plumbing.

@tekton-robot tekton-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Oct 31, 2022
@tekton-robot
Copy link
Collaborator

Stale issues rot after 30d of inactivity.
Mark the issue as fresh with /remove-lifecycle rotten with a justification.
Rotten issues close after an additional 30d of inactivity.
If this issue is safe to close now please do so with /close with a justification.
If this issue should be exempted, mark the issue as frozen with /lifecycle frozen with a justification.

/lifecycle rotten

Send feedback to tektoncd/plumbing.

@tekton-robot tekton-robot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Nov 30, 2022
@ywluogg ywluogg closed this as completed Dec 1, 2022
Repository owner moved this from Todo to Done in Tekton Community Roadmap Dec 1, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/feature Categorizes issue or PR as related to a new feature. lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed.
Projects
Status: Done
Development

No branches or pull requests

2 participants