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 PipelineWorkspaceDeclaration instead of WorkspacePipelineDeclaration 👷‍♀️ #2717

Merged
merged 1 commit into from Jun 4, 2020

Conversation

bobcatfish
Copy link
Collaborator

@bobcatfish bobcatfish commented May 29, 2020

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:

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

The field WorkspacePipelineDeclaration in the API go library is now called PipelineWorkspaceDeclaration

@tekton-robot tekton-robot added the kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. label May 29, 2020
@tekton-robot tekton-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label May 29, 2020
@tekton-robot
Copy link
Collaborator

This PR cannot be merged: expecting exactly one kind/ label

Available kind/ labels are:

kind/bug: Categorizes issue or PR as related to a bug.
kind/flake: Categorizes issue or PR as related to a flakey test
kind/cleanup: Categorizes issue or PR as related to cleaning up code, process, or technical debt.
kind/design: Categorizes issue or PR as related to design.
kind/documentation: Categorizes issue or PR as related to documentation.
kind/feature: Categorizes issue or PR as related to a new feature.
kind/misc: Categorizes issue or PR as a miscellaneuous one.

@bobcatfish bobcatfish added kind/api-change Categorizes issue or PR as related to adding, removing, or otherwise changing an API and removed kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. labels May 29, 2020
Copy link

@ghost ghost left a 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?

@tekton-robot
Copy link
Collaborator

[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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@tekton-robot tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 1, 2020
@jlpettersson
Copy link
Member

Possibly silly question but: Does renaming things count as API changes to someone writing code against a Pipeline client?

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" ?

@pritidesai
Copy link
Member

Possibly silly question but: Does renaming things count as API changes to someone writing code against a Pipeline client?

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 API Change 👍 but CLI repo has a reference here:

https://github.com/tektoncd/cli/blob/85e53f79d71f9373b22a9ed62c0dd06b4e9f54f7/pkg/cmd/pipeline/start_test.go#L3152

How does this change impact CLI? /lgtm if its not breaking CLI 😲

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.

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 <sbws@google.com>
@bobcatfish
Copy link
Collaborator Author

Added the alias like you suggested @vdemeester , PTAL!

I also opened #2748 to create more clarity around our policy for client lib changes.

@bobcatfish bobcatfish added kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. and removed kind/api-change Categorizes issue or PR as related to adding, removing, or otherwise changing an API labels Jun 3, 2020
@pritidesai
Copy link
Member

thanks @bobcatfish
/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Jun 4, 2020
@tekton-robot tekton-robot merged commit ae69af2 into tektoncd:master Jun 4, 2020
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. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants