-
Notifications
You must be signed in to change notification settings - Fork 110
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
Add catlin bump
feature to bump catalog entries
#994
Conversation
Prior to this commit a user developing a new catalog entry would have to manually copy the existing latest version to a new version directory. e.g. `cp -R "0.6" "0.7"` This commit adds a command to Catlin to bump a catalog entry's version. Example usage: `catlin bump ../../path/to/catalog/task/git-clone`
This PR gets the feature off the ground but there's more to expand on: it would be great if it also edited the files of the new version so that annotations and documentation were automatically updated too. |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: 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 |
Also ccing some of the other catlin authors for review. Cheers! /cc @vinamra28 |
@sbwsg: GitHub didn't allow me to request PR reviews from the following users: vinamra28, PuneetPunamiya. Note that only tektoncd members and repo collaborators can review this PR, and authors cannot review their own PRs. 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. |
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.
looks great, thank you so much @sbwsg 🎉
/lgtm
/kind feature |
Today, we don't always bump versions of resources when updating them. The guideline has been to bump versions only when behavior changes, but it's hard to figure out when the behavior has changed (a change that could be trivial to one user could be meaningful to another). Not bumping resource versions when changing them causes issues where the resource definition becomes dependent on the time when it was applied by the user - which causes unexpected failures as described in tektoncd#784. This issue also came up as an issue where users cannot depend on the Step indices because they can change: tektoncd/community#572 (review). In TEP-0003, we already proposed that a policy for versioning of resources: https://github.com/tektoncd/community/blob/main/teps/0003-tekton-catalog-organization.md#versioning-resources In Catalog Working Group on 01/13/2022, we revisted that policy and: - agreed to follow the versioning policy - make it easier to bump resources (see tektoncd/plumbing#994) This change documents the versioning policy. Fxes tektoncd#784
Today, we don't always bump versions of resources when updating them. The guideline has been to bump versions only when behavior changes, but it's hard to figure out when the behavior has changed (a change that could be trivial to one user could be meaningful to another). Not bumping resource versions when changing them causes issues where the resource definition becomes dependent on the time when it was applied by the user - which causes unexpected failures as described in tektoncd#784. This issue also came up as an issue where users cannot depend on the Step indices because they can change: tektoncd/community#572 (review). In TEP-0003, we already proposed that a policy for versioning of resources: https://github.com/tektoncd/community/blob/main/teps/0003-tekton-catalog-organization.md#versioning-resources In Catalog Working Group on 01/13/2022, we revisted that policy and: - agreed to follow the versioning policy - make it easier to bump resources (see tektoncd/plumbing#994) This change documents the versioning policy in the contributions guide. Fixes tektoncd#784
Today, we don't always bump versions of resources when updating them. The guideline has been to bump versions only when behavior changes, but it's hard to figure out when the behavior has changed (a change that could be trivial to one user could be meaningful to another). Not bumping resource versions when changing them causes issues where the resource definition becomes dependent on the time when it was applied by the user - which causes unexpected failures as described in tektoncd#784. This issue also came up as an issue where users cannot depend on the Step indices because they can change: tektoncd/community#572 (review). In TEP-0003, we already proposed that a policy for versioning of resources: https://github.com/tektoncd/community/blob/main/teps/0003-tekton-catalog-organization.md#versioning-resources In Catalog Working Group on 01/13/2022, we revisited that policy and: - agreed to follow the versioning policy - make it easier to bump resources (see tektoncd/plumbing#994) This change documents the versioning policy in the contributions guide. Fixes tektoncd#784
Changes
Prior to this commit a user developing a new version of a catalog entry would have to
manually copy the existing latest version to a new version directory. e.g.
This commit adds a command to Catlin to bump a catalog entry's version.
Example usage:
catlin bump ../../path/to/catalog/task/git-clone
Contributes to tektoncd/catalog#784
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.