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.

Sign up for GitHub

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

Jump to bottom

Deprecation Notice for Results Field for PipelineRuns and TaskRuns #1278

Merged
merged 1 commit into from
Sep 5, 2019
Merged

Deprecation Notice for Results Field for PipelineRuns and TaskRuns #1278

merged 1 commit into from
Sep 5, 2019

Conversation

danielhelfand
Copy link
Member

@danielhelfand danielhelfand commented Sep 5, 2019 •
edited
Loading

As discussed in #1268, there should be proper notice given before addressing #1243. The plan is to announce in release notes for 0.7.0 that the Results field for pipelineruns and taskruns will be removed by v0.8.0.

This pull request adds code comments to the API to create awareness about Results going away in 0.8.0. I also addressed some typos in api_compatibility_policy.md.

Submitter Checklist

These are the criteria that every PR should meet, please check them off as you
review them:

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

Adding code comments to bring awareness to Results field removal in v0.8.0

@googlebot googlebot added the cla: yes Trying to make the CLA bot happy with ppl from different companies work on one commit label Sep 5, 2019
@tekton-robot tekton-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Sep 5, 2019
@tekton-robot
Copy link
Collaborator

Hi @danielhelfand. Thanks for your PR.

I'm waiting for a tektoncd member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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.

@tekton-robot tekton-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Sep 5, 2019
ghost
ghost reviewed Sep 5, 2019
View reviewed changes
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.

/ok-to-test

pkg/apis/pipeline/v1alpha1/pipelinerun_types.go Outdated
@@ -112,7 +115,9 @@ type PipelineRef struct {
type PipelineRunStatus struct {
duckv1beta1.Status `json:",inline"`

// In #107 should be updated to hold the location logs have been uploaded to
// Deprecation Notice: The field Results will be deprecated in v0.8.0
Copy link

Choose a reason for hiding this comment

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

will be deprecated in v0.8.0 -> will be removed in v0.8.0. I think we're technically deprecating it in 0.7.0 by making the announcement :)

Same comment for the other lines/files where this notice appears.

Copy link
Member Author

Choose a reason for hiding this comment

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

Thanks for catching that. Changed to will be removed in v0.8.0.

@tekton-robot tekton-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Sep 5, 2019
@ghost
Copy link

ghost commented Sep 5, 2019

/lgtm

@tekton-robot tekton-robot assigned ghost Sep 5, 2019
@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Sep 5, 2019
dibyom
dibyom approved these changes Sep 5, 2019
View reviewed changes
Copy link
Member

@dibyom dibyom left a comment

Choose a reason for hiding this comment

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

thanks @danielhelfand 😃

/approve

@tekton-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: danielhelfand, dibyom

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 Sep 5, 2019
@danielhelfand
Copy link
Member Author

@dibyom Happy to help! Appreciate your review.

@tekton-robot tekton-robot merged commit 6e7e97f into tektoncd:master Sep 5, 2019
@bobcatfish
Copy link
Collaborator

Thanks @danielhelfand !! ❤️

@danielhelfand
Copy link
Member Author

@bobcatfish Sure thing! Thanks for writing up the issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dibyom dibyom dibyom approved these changes

@imjasonh imjasonh Awaiting requested review from imjasonh

@vdemeester vdemeester Awaiting requested review from vdemeester

Assignees
No one assigned
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cla: yes Trying to make the CLA bot happy with ppl from different companies work on one commit lgtm Indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@danielhelfand @tekton-robot @bobcatfish @dibyom @googlebot