-
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
Rename containerTemplate
to stepTemplate
👠
#931
Conversation
@abayer I think this is relevant to your interests! 🙏 |
And this is an API change so would like to review from several of @vdemeester @dlorenc @imjasonh ❤️ |
/hold |
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 am 👍 on this change as it's more coherent with the steps
field.
We will need a huge warning in the release note. I don't think there is any task in the catalog
using containerTemplate
yet, but we will need to make sure and follow-up in there. Also, the fact that this is green, it feels we don't have yaml tests using containerTemplate
here, would be cool to have some 👼
/lgtm I’m a strong +1 on this. It’s definitely a more explanatory name! |
maybe we can have a section in the future for "backwards incompatible changes". Leave this one with me! :D
Added! |
PTAL :D /meow space |
In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
/lgtm |
@abayer: Bad category. Please see https://api.thecatapi.com/api/categories/list In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
/meow boxes Dang it. =) |
@abayer: Bad category. Please see https://api.thecatapi.com/api/categories/list In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
/meow boxes |
In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
it was all worth it 🐱 |
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.
/lgtm
@imjasonh suggested that we use this change to try out rolling out a backward incompatible change across 2 releases so I'm gonna do that! |
The most direct consumers of the pipeline API are the other Tekton projects, so we could try and make sure we coordinate the release with them. |
There's more about this at https://github.com/tektoncd/pipeline/blob/master/api_compatibility_policy.md#possibly-beta-in-03 (where we theorize we might go beta in 0.3 haha... maybe we should go beta now though, it seems like folks are surprised by the idea that we might make a backward incompatible change? 🤔 ) |
So, overall we could have something like that. We should try to follow Kubernetes deprecation policy as much as possible.
As we are in Alpha right now, we don't really have anything to do, this is the reason why we use We could also, bump the version to
And, this brings to the table a discussion about how and when to promote our API to the Beta phase, aka |
Created #977 to actually make the backward incompatible change. |
Okay I've updated the change in this PR to be backward compatible for now - PTAL @vdemeester @abayer @chmouel @imjasonh @afrittoli 😸 |
668fe1c
to
53db5c9
Compare
@bobcatfish needs a rebase 😓 otherwise looking good (took the same approach for #1004 ) |
We used the term `containerTemplate` for this template b/c it is a template of the containers used for each step - however we don't refer to those as containers, we refer to them as steps, so I think calling this `stepTemplate` makes slightly more sense and makes the relationship between this template + the steps a bit more obvious. This change is backward compatible b/c both `containerTemplate` and `stepTemplate` will be supported until tektoncd#977 where we will make the backward incompatible change and remove `containerTemplate`.
There weren't any "yaml tests" aka examples that used the stepTemplate so after I renamed `stepTemplate` from `containerTemplate` it was not 100% clear if this worked. Also it's helpful to provide examples to users to see it in action :)
This should be rebased and ready to go now @vdemeester ! /hold cancel |
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.
/lgtm
A quick update is gonna be needed in the tektoncd/catalog
once we do a release
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: bobcatfish, chmouel, 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 |
In tektoncd#931 we added `stepTemplate` in addition to `containerTemplate` and this chagne went out with 0.5. In this release we can now remove containerTemplate completely. Fixes tektoncd#977
Changes
We used the term
containerTemplate
for this template b/c it is atemplate of the containers used for each step - however we don't refer
to those as containers, we refer to them as steps, so I think calling
this
stepTemplate
makes slightly more sense and makes the relationshipbetween this template + the steps a bit more obvious.
This change is backward compatible b/c both
containerTemplate
andstepTemplate
will be supported until #977 where we will make thebackward incompatible change and remove
containerTemplate
.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.
Release Notes