-
Notifications
You must be signed in to change notification settings - Fork 1.8k
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 PipelineWorkspaceDeclaration instead of WorkspacePipelineDeclaration 👷♀️ #2717
Conversation
This PR cannot be merged: expecting exactly one kind/ label Available
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Possibly silly question but: Does renaming things count as API changes to someone writing code against a Pipeline client?
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: sbwsg 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 |
I was thinking about this too. This is just a change of the Go-client API, but no changes in the Yaml API or REST API - so I would not count it as an "api change" ? |
Ditto, would not count as an How does this change impact CLI? /lgtm if its not breaking CLI 😲 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I was thinking about this too. This is just a change of the Go-client API, but no changes in the Yaml API or REST API - so I would not count it as an "api change" ?
I doesn't count as an API change, and we can "smooth" things when doing those changes too by using type alias and a // Deprecated: use …
comment 😉
// WorkspacePipelineDeclaration creates a named slot in a Pipeline that a PipelineRun […]
// Deprecated: use PipelineWorkspaceDeclaration type instead
type WorkspacePipelineDeclaration = PipelineWorkspaceDeclaration
That would ensure that we do not break external user and give them time to switch to the new type before removing it 👼 😉
…ion 👷♀️ This is a super minor change to rename WorkspacePipelineDeclaration to PipelineWorkspaceDeclaration. WorkspacePipelineDeclaration sounds like it's a pipeline declaration inside of a workspace, but actually its meant to be a workspace declaration inside of a pipeline! I'm trying to pickup some of the work started in tektoncd#1936 and this seemed like a reasonable improvement to carve off and merge on its own :D Co-authored-by: Scott <[email protected]>
Added the alias like you suggested @vdemeester , PTAL! I also opened #2748 to create more clarity around our policy for client lib changes. |
thanks @bobcatfish |
Changes
This is a super minor change to rename WorkspacePipelineDeclaration to
PipelineWorkspaceDeclaration. WorkspacePipelineDeclaration sounds like
it's a pipeline declaration inside of a workspace, but actually its
meant to be a workspace declaration inside of a pipeline!
I'm trying to pickup some of the work started in #1936
and this seemed like a reasonable improvement to carve off and merge on
its own :D
co-authored with @sbwsg
/kind cleanup
Submitter Checklist
These are the criteria that every PR should meet, please check them off as you
review them:
See the contribution guide for more details.
Double check this list of stuff that's easy to miss:
cmd
dir, please updatethe release Task to build and release this image.
Reviewer Notes
If API changes are included, additive changes must be approved by at least two OWNERS and backwards incompatible changes must be approved by more than 50% of the OWNERS, and they must first be added in a backwards compatible way.
Release Notes