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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Versioning Resources #918

Closed
wants to merge 1 commit into from
Closed

Versioning Resources #918

wants to merge 1 commit into from

Conversation

jerop
Copy link
Member

@jerop jerop commented Jan 31, 2022

Changes

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 #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:

This change documents the versioning policy in the contributions guide.

Fixes #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.

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
@tekton-robot tekton-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Jan 31, 2022
Copy link
Member

@vinamra28 vinamra28 left a comment

Choose a reason for hiding this comment

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

/cc @tektoncd/catalog-maintainers

@tekton-robot tekton-robot requested a review from a team February 1, 2022 14:40
@tekton-robot
Copy link

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: vinamra28

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 Feb 1, 2022
@chmouel
Copy link
Member

chmouel commented Feb 1, 2022

if every time there is an update of a software which is in a task or we have to fix something in it (like documentation) we have to bump this may results a large number of tasks.

It's maybe find and I am not sure if it's bad or not and could end up with some scaling issues.

I wish we could use git as versioning system instead of directory structure but I am not sure how we can achieve that.

so basically my vote is neutral :)

@tekton-robot
Copy link

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale with a justification.
Stale issues rot after an additional 30d of inactivity and eventually close.
If this issue is safe to close now please do so with /close with a justification.
If this issue should be exempted, mark the issue as frozen with /lifecycle frozen with a justification.

/lifecycle stale

Send feedback to tektoncd/plumbing.

@tekton-robot tekton-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label May 2, 2022
@jerop
Copy link
Member Author

jerop commented May 2, 2022

/lifecycle frozen

@tekton-robot tekton-robot added lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels May 2, 2022
@jerop
Copy link
Member Author

jerop commented May 2, 2022

hoping the work in TEP-0101 will address this issue, so closing this pull request

@jerop jerop closed this May 2, 2022
@jerop jerop deleted the versioning branch June 11, 2022 03:00
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. lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. 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.

Update policy to bump Task/Pipeline versions whenever a change is made
4 participants