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

[TEP074] Remove CloudEvent pipelineResources #5995

Merged
merged 1 commit into from
Jan 19, 2023

Conversation

JeromeJu
Copy link
Member

@JeromeJu JeromeJu commented Jan 16, 2023

Changes

This commit removes the CloudEvent Resources support.
Removal of pipelineResources, as in #5967 has been broken up into removal of each
resources packages for the small PR code standard.
This PR removes github.com/tektoncd/pipeline/pkg/apis/resource/v1alpha1/cloudevent
the respective example test and docs for cloud-event resources.

Part of #5967
/kind misc

Submitter Checklist

As the author of this PR, please check off the items in this checklist:

  • [n/a] Has Docs included if any changes are user facing
  • Has Tests included if any functionality added or changed
  • Follows the commit message standard
  • Meets the Tekton contributor standards (including
    functionality, content, code)
  • Has a kind label. You can add one by adding a comment on this PR that contains /kind <type>. Valid types are bug, cleanup, design, documentation, feature, flake, misc, question, tep
  • Release notes block below has been updated with any user facing changes (API changes, bug fixes, changes requiring upgrade notices or deprecation warnings)
  • Release notes contains the string "action required" if the change requires additional action from users switching to the new release

Release Notes

action required: please migrate off of `cloudevent` `pipelineresources` as it is removed, please refer to the doc at https://github.com/tektoncd/pipeline/blob/main/docs/pipelineresources.md#replacing-a-cloudevent-resource

@tekton-robot tekton-robot added the release-note-none Denotes a PR that doesnt merit a release note. label Jan 16, 2023
@tekton-robot tekton-robot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. kind/misc Categorizes issue or PR as a miscellaneuous one. release-note Denotes a PR that will be considered when it comes time to generate release notes. and removed release-note-none Denotes a PR that doesnt merit a release note. labels Jan 16, 2023
@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/reconciler/events/cloudevent/cloud_event_controller.go 88.9% 87.8% -1.1
pkg/reconciler/taskrun/taskrun.go 83.6% 83.5% -0.1

@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage-df to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/reconciler/events/cloudevent/cloud_event_controller.go 88.9% 87.8% -1.1
pkg/reconciler/taskrun/taskrun.go 83.6% 83.5% -0.1

@tekton-robot tekton-robot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Jan 16, 2023
@JeromeJu JeromeJu changed the title Remove CloudEvent Resources Remove Resources Jan 16, 2023
@JeromeJu JeromeJu changed the title Remove Resources Remove pipelineResources Jan 16, 2023
@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/reconciler/events/cloudevent/cloud_event_controller.go 88.9% 87.8% -1.1
pkg/reconciler/taskrun/taskrun.go 83.6% 83.5% -0.1

@tekton-robot tekton-robot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Jan 16, 2023
@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage-df to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/reconciler/events/cloudevent/cloud_event_controller.go 88.9% 87.8% -1.1
pkg/reconciler/taskrun/taskrun.go 83.6% 83.5% -0.1

@JeromeJu JeromeJu changed the title Remove pipelineResources Remove CloudEvent pipelineResources Jan 16, 2023
@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/reconciler/events/cloudevent/cloud_event_controller.go 88.9% 87.8% -1.1
pkg/reconciler/taskrun/taskrun.go 83.6% 83.5% -0.1

@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage-df to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/reconciler/events/cloudevent/cloud_event_controller.go 88.9% 87.8% -1.1
pkg/reconciler/taskrun/taskrun.go 83.6% 83.5% -0.1

@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/reconciler/events/cloudevent/cloud_event_controller.go 88.9% 87.8% -1.1
pkg/reconciler/taskrun/taskrun.go 83.6% 83.5% -0.1

@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage-df to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/reconciler/events/cloudevent/cloud_event_controller.go 88.9% 87.8% -1.1
pkg/reconciler/taskrun/taskrun.go 83.6% 83.5% -0.1

@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/reconciler/events/cloudevent/cloud_event_controller.go 88.9% 87.8% -1.1
pkg/reconciler/taskrun/taskrun.go 83.6% 83.5% -0.1

@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage-df to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/reconciler/events/cloudevent/cloud_event_controller.go 88.9% 87.8% -1.1
pkg/reconciler/taskrun/taskrun.go 83.6% 83.5% -0.1

@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage-df to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/reconciler/events/cloudevent/cloud_event_controller.go 88.9% 84.9% -4.0
pkg/reconciler/taskrun/taskrun.go 83.6% 83.6% 0.0

@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/reconciler/events/cloudevent/cloud_event_controller.go 88.9% 84.9% -4.0
pkg/reconciler/taskrun/taskrun.go 83.6% 83.6% 0.0

@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage-df to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/reconciler/events/cloudevent/cloud_event_controller.go 88.9% 84.9% -4.0
pkg/reconciler/taskrun/taskrun.go 83.6% 83.6% 0.0

@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/reconciler/events/cloudevent/cloud_event_controller.go 88.9% 84.9% -4.0
pkg/reconciler/taskrun/taskrun.go 83.6% 83.6% 0.0

@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage-df to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/reconciler/events/cloudevent/cloud_event_controller.go 88.9% 84.9% -4.0
pkg/reconciler/taskrun/taskrun.go 83.6% 83.6% 0.0

This commit removes the CloudEvent Resources support.
This PR removes ,
its respective example test, relevant functions in cloud_event_controller and docs
for cloud-event resources.

Removal of , as in tektoncd#5967 has been broken up into removal of each
resources packages for the  code standard.
@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/reconciler/events/cloudevent/cloud_event_controller.go 88.9% 84.9% -4.0
pkg/reconciler/taskrun/taskrun.go 83.6% 83.6% 0.0

@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage-df to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/reconciler/events/cloudevent/cloud_event_controller.go 88.9% 84.9% -4.0
pkg/reconciler/taskrun/taskrun.go 83.6% 83.6% 0.0

@JeromeJu JeromeJu requested review from afrittoli and removed request for bobcatfish and jerop January 18, 2023 15:46
Copy link
Member

@afrittoli afrittoli left a comment

Choose a reason for hiding this comment

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

Thank you @JeromeJu, this looks great.

The 'cloudevent_count' metric counts cloudevent sent via the PipelineResource, so it doesn't make any more sense. I don't think we added metrics to the API stability policy, so it should be safe to remove. Besides, it wouldn't report anything at all.

I noticed that taskRun.status.CloudEvents has only just been marked as deprecated and is not planned for removal until Oct 2023.

I though that when we deprecated PipelineResources we also deprecated all parts of the API associated with them, which would include resource inputs/outputs, resource results and cloudevents status. It may be that we were not explicit about the parts of the API affected, but I'm not sure we should keep around an API which is not used by anything.

@tektoncd/core-maintainers thoughts about this?

I don't think this discussion should block this PR, so it's fine to move ahead and possibly further cleanup in a follow-up PR. Perhaps here we could remove the metric at least?

@JeromeJu
Copy link
Member Author

JeromeJu commented Jan 19, 2023

Many thanks @afrittoli for the detailed look into this removal and the respective effects on the related APIs. I have done the following so this PR might get in more safely for now. :)

@vdemeester
Copy link
Member

I though that when we deprecated PipelineResources we also deprecated all parts of the API associated with them, which would include resource inputs/outputs, resource results and cloudevents status. It may be that we were not explicit about the parts of the API affected, but I'm not sure we should keep around an API which is not used by anything.

@tektoncd/core-maintainers thoughts about this?

That was my thought as well.

@tekton-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: lbernick, 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:
  • OWNERS [lbernick,vdemeester]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@Yongxuanzhang
Copy link
Member

/lgtm

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/misc Categorizes issue or PR as a miscellaneuous one. lgtm Indicates that a PR is ready to be merged. release-note-action-required Denotes a PR that introduces potentially breaking changes that require user action. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants