tektoncd / tektoncd/operator

remove SendCloudEventsForRuns from PipelineProperties once upstream pipeline drops the field

Open
#3,439 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
608
Forks
263
Avg merge
1d 3h
Merged PRs (30d)
125

Description

Summary

The send-cloudevents-for-runs feature flag was deprecated in tektoncd/pipeline v1.12.0
(tektoncd/pipeline#9774).
CloudEvents for CustomRuns are now enabled by default when a sink is configured in the
config-events ConfigMap.

The SendCloudEventsForRuns field in PipelineProperties was marked deprecated in #3430,
which also updated the default from false to true to align with upstream behaviour.

Prerequisite

This removal must only happen after send-cloudevents-for-runs is fully removed from
tektoncd/pipeline.

Track upstream removal progress here:

  • Upstream deprecation: tektoncd/pipeline#9774
  • Watch for the upstream issue/PR that removes the field entirely from tektoncd/pipeline
    before acting on this issue.

What needs to be done (after upstream field is removed)

  • Confirm send-cloudevents-for-runs is fully removed from the upstream
    tektoncd/pipeline release being consumed by the operator
  • Remove SendCloudEventsForRuns field from PipelineProperties struct in
    pkg/apis/operator/v1alpha1/tektonpipeline_types.go
  • Remove the corresponding SetDefaults logic in
    pkg/apis/operator/v1alpha1/tektonpipeline_defaults.go
  • Update / remove affected unit tests
  • Update documentation (docs/TektonPipeline.md) to remove references to
    send-cloudevents-for-runs
  • Add a release note entry

Notes

  • This field only ever affected CustomRun objects; it has no effect on TaskRun or
    PipelineRun.
  • Users who set send-cloudevents-for-runs: false to suppress duplicate events from a
    custom task controller that already sends its own CloudEvents should be made aware via
    release notes when this removal lands.
  • See similar precedent: removal of the deprecated verification-mode field tracked in
    #1497.

References

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

First verify that send-cloudevents-for-runs and its upstream field are fully removed from the tektoncd/pipeline release consumed by the operator. Then inspect pkg/apis/operator/v1alpha1/tektonpipeline_types.go and tektonpipeline_defaults.go, update affected unit tests, remove the reference from docs/TektonPipeline.md, and add a release note. Done means the deprecated field and defaulting logic are removed without affected tests or documentation references remaining.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
infrastructure
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.