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

Use SchemeGroupVersion for tekton objects in cluster resolver #5705

Merged
merged 1 commit into from
Nov 3, 2022

Conversation

chuangw6
Copy link
Member

@chuangw6 chuangw6 commented Nov 1, 2022

Changes

/kind cleanup

Prior, the cluster resolver sets the APIVersion of the retrieved tekton object to be a fixed string "tekton.dev/v1beta1".

Now, we changed this to v1beta1.SchemeGroupVersion.String() for easier transition to v1 once v1 is released.

Signed-off-by: Chuang Wang [email protected]

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

Use v1beta1.SchemeGroupVersion.String() for the APIVersion field in the tekton object retrieved by cluster resolver.

@tekton-robot tekton-robot added kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. release-note Denotes a PR that will be considered when it comes time to generate release notes. labels Nov 1, 2022
@tekton-robot tekton-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Nov 1, 2022
@chuangw6 chuangw6 mentioned this pull request Nov 1, 2022
7 tasks
@tekton-robot
Copy link
Collaborator

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/resolution/resolver/cluster/resolver.go 86.2% 86.4% 0.2

@chuangw6
Copy link
Member Author

chuangw6 commented Nov 1, 2022

/retest

Prior, the cluster resolver sets the APIVersion of the retrieved tekton object
to be a fixed string "tekton.dev/v1beta1".

Now, we changed this to `v1beta1.SchemeGroupVersion.String()` for easier
transition to v1 once v1 is released.

Signed-off-by: Chuang Wang <[email protected]>
@chuangw6 chuangw6 force-pushed the small-fix-clusterresolver branch from c2f54e5 to 4bafd12 Compare November 1, 2022 14:55
@tekton-robot
Copy link
Collaborator

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/resolution/resolver/cluster/resolver.go 86.2% 86.4% 0.2

@@ -101,6 +101,7 @@ func (r *Resolver) Resolve(ctx context.Context, origParams []pipelinev1beta1.Par
}

var data []byte
groupVersion := pipelinev1beta1.SchemeGroupVersion.String()
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Chuang! I was wondering if there is any way we can link this to the storage version?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What could happen if the version is not correctly specified?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry for the delay @JeromeJu .

I was wondering if there is any way we can link this to the storage version?

Not sure how we can get the storage version. I think pipelinev1beta1.SchemeGroupVersion.String() might be sufficient here as andrew suggested here. Once we switched to v1, we need to change the imported pkg and this version will be changed accordingly I think.

What could happen if the version is not correctly specified?

That's a good question. I just played around this. If the typemeta i.e. the version or kind is not set correctly, the resolution will still succeed, but the code of converting the retrieved content to the runtime object will fail. And it will complain "no kind "Task" is registered for version "v1" in scheme ...", which makes sense because we don't serve the v1 CRD in the cluster.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the findings Chuang, and yeah I think that is very reasonable.

@abayer
Copy link
Contributor

abayer commented Nov 3, 2022

/approve

@tekton-robot tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Nov 3, 2022
Copy link
Member

@vdemeester vdemeester left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Nov 3, 2022
@tekton-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: abayer, vdemeester

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

@abayer
Copy link
Contributor

abayer commented Nov 3, 2022

/retest

@tekton-robot tekton-robot merged commit 8f7857e into tektoncd:main Nov 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. lgtm Indicates that a PR is ready to be merged. release-note Denotes a PR that will be considered when it comes time to generate release notes. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants