[TEP-0137] Rename customrun package #6884

afrittoli · 2023-06-28T10:05:06Z

Dependencies:

[TEP-0137] Add events config map #6883

Once dependencies are merged, the PR will contain 1 commit only

Changes

The pkg/reconciler/customrun package contains a controller that
today sends cloudevents for CustomRuns. In the context of TEP-0137,
this controller will be repurposed to send events for all resources,
so the current name does not make sense anymore.

Renaming the package to "notifications", because the "events" and
"cloudevents" names are already used elsewhere and we don't want
a mass API rename for this. We might consolidate the code further
as a follow-up. The new name is also more future-proof, as the
controller may in future handle other kinds of non-cloudevents
type of notifications.

When renaming I realised that the customrun controller was being
started as part of the main controller as well as an independent
one. This PR fixes that bug as well.

Signed-off-by: Andrea Frittoli andrea.frittoli@uk.ibm.com

Submitter Checklist

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

Has Docs if any changes are user facing, including updates to minimum requirements e.g. Kubernetes version bumps
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). See some examples of good release notes.
Release notes contains the string "action required" if the change requires additional action from users switching to the new release

Release Notes

The `CustomRun` events controller has been moved to the `pkg/reconciler/notifications` package.

/kind misc

tekton-robot · 2023-06-28T10:14:18Z

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/apis/config/events.go	Do not exist	98.1%
pkg/apis/config/store.go	91.7%	92.6%	0.9
pkg/reconciler/events/cloudevent/cloud_event_controller.go	84.9%	84.6%	-0.3
pkg/reconciler/notifications/controller.go	Do not exist	100.0%
pkg/reconciler/notifications/notifications.go	Do not exist	100.0%
test/controller.go	29.4%	30.1%	0.7

tekton-robot · 2023-06-28T10:16:10Z

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/apis/config/events.go	Do not exist	98.1%
pkg/apis/config/store.go	91.7%	92.6%	0.9
pkg/reconciler/events/cloudevent/cloud_event_controller.go	84.9%	84.6%	-0.3
pkg/reconciler/notifications/controller.go	Do not exist	100.0%
pkg/reconciler/notifications/notifications.go	Do not exist	100.0%
test/controller.go	29.4%	30.1%	0.7

tekton-robot · 2023-06-28T10:29:15Z

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/apis/config/events.go	Do not exist	98.1%
pkg/apis/config/store.go	91.7%	92.6%	0.9
pkg/reconciler/events/cloudevent/cloud_event_controller.go	84.9%	84.6%	-0.3
pkg/reconciler/notifications/customrun/controller.go	Do not exist	100.0%
pkg/reconciler/notifications/customrun/customrun.go	Do not exist	100.0%
test/controller.go	29.4%	30.1%	0.7

tekton-robot · 2023-06-28T10:30:46Z

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/apis/config/events.go	Do not exist	98.1%
pkg/apis/config/store.go	91.7%	92.6%	0.9
pkg/reconciler/events/cloudevent/cloud_event_controller.go	84.9%	84.6%	-0.3
pkg/reconciler/notifications/customrun/controller.go	Do not exist	100.0%
pkg/reconciler/notifications/customrun/customrun.go	Do not exist	100.0%
test/controller.go	29.4%	30.1%	0.7

tekton-robot · 2023-06-30T13:56:22Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: lbernick

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]

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

The pkg/reconciler/customrun package contains a controller that today sends cloudevents for CustomRuns. In the context of TEP-0137, more controllers will be added to send events for all resources, so the current name does not make sense anymore. Renaming the package to "notifications/customrun", so that the notifications package may hold the various controllers for the different kind of resources. The "events" and "cloudevents" names are already used elsewhere and we don't want a mass API rename for this. We might consolidate the code further as a follow-up. The new name is also more future-proof, as the controllers may in future handle other kinds of non-cloudevents type of notifications. When renaming I realised that the customrun controller was being started as part of the main controller as well as an independent one. This PR fixes that bug as well. Signed-off-by: Andrea Frittoli <andrea.frittoli@uk.ibm.com>

tekton-robot · 2023-07-03T12:29:13Z

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/notifications/customrun/controller.go	Do not exist	100.0%
pkg/reconciler/notifications/customrun/customrun.go	Do not exist	100.0%

afrittoli · 2023-07-03T21:00:39Z

/retest

afrittoli · 2023-07-03T21:00:48Z

/test pull-tekton-pipeline-go-coverage-df

tekton-robot · 2023-07-03T21:00:50Z

@afrittoli: The specified target(s) for /test were not found.
The following commands are available to trigger required jobs:

/test pull-tekton-pipeline-alpha-integration-tests
/test pull-tekton-pipeline-beta-integration-tests
/test pull-tekton-pipeline-build-tests
/test pull-tekton-pipeline-integration-tests
/test tekton-pipeline-unit-tests

The following commands are available to trigger optional jobs:

/test pull-tekton-pipeline-go-coverage

Use /test all to run all jobs.

In response to this:

/test pull-tekton-pipeline-go-coverage-df

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 · 2023-07-03T21:10:16Z

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/notifications/customrun/controller.go	Do not exist	100.0%
pkg/reconciler/notifications/customrun/customrun.go	Do not exist	100.0%

afrittoli · 2023-07-03T23:08:35Z

/test pull-tekton-pipeline-beta-integration-tests

wlynch

/lgtm

One question though - would this break downstream customrun implementations? Should we leave behind a simple package that type aliases to the new package?

If this is truly only for cloudevent notifications, you may also want to add a doc.go with some documentation calling this out.

wlynch · 2023-07-05T15:39:12Z

/approve cancel (approve was set before LGTM - undo-ing to give a chance to respond to the comment)

wlynch · 2023-07-05T15:39:58Z

/remove-approve

afrittoli · 2023-07-05T17:35:55Z

/lgtm

One question though - would this break downstream customrun implementations? Should we leave behind a simple package that type aliases to the new package?

If this is truly only for cloudevent notifications, you may also want to add a doc.go with some documentation calling this out.

Thanks @wlynch - it looks like the un-approve didn't work, so I'll address your comments as a follow-up.
The package is exclusively used to provide the ability to send cloud events for CustomRuns, it's not something that custom run controller implementors would use.

If you prefer I can introduce an alias; in #6889 however I started restructuring that package in preparation for "TEP-0137", so I'm not sure an alias would be very helpful (or alternatively I will have rework that PR and the following one to keep the old methods around).

tekton-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. kind/misc Categorizes issue or PR as a miscellaneuous one. labels Jun 28, 2023

tekton-robot requested review from abayer and dibyom June 28, 2023 10:05

tekton-robot added the size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. label Jun 28, 2023

afrittoli force-pushed the tep0137_tektonv1 branch from 82e4a78 to 8e274a7 Compare June 28, 2023 10:08

afrittoli marked this pull request as draft June 28, 2023 10:13

tekton-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jun 28, 2023

afrittoli changed the title ~~[TEP-0137] Rename customrun package to notifications~~ [TEP-0137] Rename customrun package Jun 28, 2023

afrittoli force-pushed the tep0137_tektonv1 branch from 8e274a7 to 75b175b Compare June 28, 2023 10:22

afrittoli marked this pull request as ready for review June 28, 2023 10:22

tekton-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jun 28, 2023

tekton-robot requested review from lbernick and wlynch June 28, 2023 10:22

afrittoli mentioned this pull request Jun 29, 2023

[TEP-0137] Restructure customrun event controller #6889

Open

9 tasks

afrittoli added kind/tep Categorizes issue or PR as related to a TEP (or needs a TEP). and removed kind/tep Categorizes issue or PR as related to a TEP (or needs a TEP). labels Jun 30, 2023

lbernick approved these changes Jun 30, 2023

View reviewed changes

tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 30, 2023

afrittoli force-pushed the tep0137_tektonv1 branch from 75b175b to ea090ba Compare July 3, 2023 12:23

tekton-robot added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Jul 3, 2023

wlynch reviewed Jul 5, 2023

View reviewed changes

tekton-robot assigned wlynch Jul 5, 2023

tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Jul 5, 2023

tekton-robot merged commit a9017c5 into tektoncd:main Jul 5, 2023

afrittoli mentioned this pull request Jul 10, 2023

[TEP-0137] Rework the events controller cache #6914

Open

10 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[TEP-0137] Rename customrun package #6884

[TEP-0137] Rename customrun package #6884

afrittoli commented Jun 28, 2023 •

edited by vdemeester

Loading

tekton-robot commented Jun 28, 2023

tekton-robot commented Jun 28, 2023

tekton-robot commented Jun 28, 2023

tekton-robot commented Jun 28, 2023

tekton-robot commented Jun 30, 2023

tekton-robot commented Jul 3, 2023

afrittoli commented Jul 3, 2023

afrittoli commented Jul 3, 2023

tekton-robot commented Jul 3, 2023

tekton-robot commented Jul 3, 2023

afrittoli commented Jul 3, 2023

wlynch left a comment

wlynch commented Jul 5, 2023

wlynch commented Jul 5, 2023

afrittoli commented Jul 5, 2023

[TEP-0137] Rename customrun package #6884

[TEP-0137] Rename customrun package #6884

Conversation

afrittoli commented Jun 28, 2023 • edited by vdemeester Loading

Dependencies:

Changes

Submitter Checklist

Release Notes

tekton-robot commented Jun 28, 2023

tekton-robot commented Jun 28, 2023

tekton-robot commented Jun 28, 2023

tekton-robot commented Jun 28, 2023

tekton-robot commented Jun 30, 2023

tekton-robot commented Jul 3, 2023

afrittoli commented Jul 3, 2023

afrittoli commented Jul 3, 2023

tekton-robot commented Jul 3, 2023

tekton-robot commented Jul 3, 2023

afrittoli commented Jul 3, 2023

wlynch left a comment

Choose a reason for hiding this comment

wlynch commented Jul 5, 2023

wlynch commented Jul 5, 2023

afrittoli commented Jul 5, 2023

afrittoli commented Jun 28, 2023 •

edited by vdemeester

Loading