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

Cleanup: Use CustomRun instead of RunObject #6718

Merged
merged 1 commit into from
Jun 8, 2023

Conversation

lbernick
Copy link
Member

@lbernick lbernick commented May 25, 2023

v1alpha1 Runs are no longer supported by the PipelineRun reconciler. The PipelineRun reconciler currently operates on RunObjects (an interface which is implemented by v1alpha1.Run and v1beta1.CustomRun). However, this code is misleading, since retry behavior differs between v1alpha1.Run and v1beta1.CustomRun, but the controller only supports the behavior of v1beta1.CustomRuns. This commit replaces usages of RunObject with CustomRun, and renames references to runs/runObjects to customRuns for clarity. No functional changes.

/kind cleanup
Partially addresses #6628

Submitter Checklist

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

  • n/a 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
  • n/a 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.
  • n/a Release notes contains the string "action required" if the change requires additional action from users switching to the new release

Release Notes

NONE

@tekton-robot tekton-robot added kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. release-note-none Denotes a PR that doesnt merit a release note. labels May 25, 2023
@tekton-robot tekton-robot added the size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. label May 25, 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/pipelinerun/pipelinerun.go 90.3% 90.4% 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/pipelinerun/pipelinerun.go 90.3% 90.4% 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/pipelinerun/pipelinerun.go 90.3% 90.4% 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/pipelinerun/pipelinerun.go 90.3% 90.4% 0.1

@lbernick
Copy link
Member Author

Unit tests are failing due to build failures, but this passes locally so I'm not sure what's going on here... 🤔

@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/pipelinerun/pipelinerun.go 90.3% 90.4% 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/pipelinerun/pipelinerun.go 90.3% 90.4% 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/pipelinerun/pipelinerun.go 90.3% 90.4% 0.1
pkg/reconciler/pipelinerun/resources/pipelinerunresolution.go 97.0% 97.0% -0.0
pkg/reconciler/pipelinerun/resources/pipelinerunstate.go 99.5% 99.5% -0.0
pkg/reconciler/pipelinerun/resources/resultrefresolution.go 92.3% 92.2% -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/pipelinerun/pipelinerun.go 90.3% 90.4% 0.1
pkg/reconciler/pipelinerun/resources/pipelinerunresolution.go 97.0% 97.0% -0.0
pkg/reconciler/pipelinerun/resources/pipelinerunstate.go 99.5% 99.5% -0.0
pkg/reconciler/pipelinerun/resources/resultrefresolution.go 92.3% 92.2% -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/pipelinerun/pipelinerun.go 90.3% 90.4% 0.1
pkg/reconciler/pipelinerun/resources/pipelinerunresolution.go 97.0% 97.0% -0.0
pkg/reconciler/pipelinerun/resources/pipelinerunstate.go 99.5% 99.5% -0.0
pkg/reconciler/pipelinerun/resources/resultrefresolution.go 92.3% 92.2% -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/pipelinerun/pipelinerun.go 90.3% 90.4% 0.1
pkg/reconciler/pipelinerun/resources/pipelinerunresolution.go 97.0% 97.0% -0.0
pkg/reconciler/pipelinerun/resources/pipelinerunstate.go 99.5% 99.5% -0.0
pkg/reconciler/pipelinerun/resources/resultrefresolution.go 92.3% 92.2% -0.1

@tekton-robot tekton-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label May 29, 2023
@tekton-robot tekton-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label May 30, 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/pipelinerun/pipelinerun.go 90.4% 90.4% 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/pipelinerun/pipelinerun.go 90.4% 90.4% 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/pipelinerun/pipelinerun.go 90.4% 90.4% 0.1
pkg/reconciler/pipelinerun/resources/pipelinerunresolution.go 97.0% 97.0% -0.0
pkg/reconciler/pipelinerun/resources/pipelinerunstate.go 99.5% 99.5% -0.0
pkg/reconciler/pipelinerun/resources/resultrefresolution.go 92.3% 92.2% -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/pipelinerun/pipelinerun.go 90.4% 90.4% 0.1
pkg/reconciler/pipelinerun/resources/pipelinerunresolution.go 97.0% 97.0% -0.0
pkg/reconciler/pipelinerun/resources/pipelinerunstate.go 99.5% 99.5% -0.0
pkg/reconciler/pipelinerun/resources/resultrefresolution.go 92.3% 92.2% -0.1

v1alpha1 Runs are no longer supported by the PipelineRun reconciler.
The PipelineRun reconciler currently operates on RunObjects (an interface
which is implemented by v1alpha1.Run and v1beta1.CustomRun).
However, this code is misleading, since retry behavior differs between v1alpha1.Run
and v1beta1.CustomRun, but the controller only supports the behavior of v1beta1.CustomRuns.
This commit replaces usages of RunObject with CustomRun, and renames references to runs/runObjects
to customRuns for clarity. No functional changes.
@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/pipelinerun/pipelinerun.go 90.4% 90.4% 0.1
pkg/reconciler/pipelinerun/resources/pipelinerunresolution.go 97.0% 97.0% -0.0
pkg/reconciler/pipelinerun/resources/pipelinerunstate.go 99.5% 99.5% -0.0
pkg/reconciler/pipelinerun/resources/resultrefresolution.go 92.3% 92.2% -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/pipelinerun/pipelinerun.go 90.4% 90.4% 0.1
pkg/reconciler/pipelinerun/resources/pipelinerunresolution.go 97.0% 97.0% -0.0
pkg/reconciler/pipelinerun/resources/pipelinerunstate.go 99.5% 99.5% -0.0
pkg/reconciler/pipelinerun/resources/resultrefresolution.go 92.3% 92.2% -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/pipelinerun/pipelinerun.go 90.4% 90.4% 0.1
pkg/reconciler/pipelinerun/resources/pipelinerunresolution.go 97.0% 97.0% -0.0
pkg/reconciler/pipelinerun/resources/pipelinerunstate.go 99.5% 99.5% -0.0
pkg/reconciler/pipelinerun/resources/resultrefresolution.go 92.3% 92.2% -0.1

Copy link
Member

@Yongxuanzhang Yongxuanzhang left a comment

Choose a reason for hiding this comment

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

/lgtm
Thanks for the cleanup!

if err != nil {
recorder.Eventf(pr, corev1.EventTypeWarning, "RunsCreationFailed", "Failed to create Runs %q: %v", rpt.RunObjectNames, err)
err = fmt.Errorf("error creating Runs called %s for PipelineTask %s from PipelineRun %s: %w", rpt.RunObjectNames, rpt.PipelineTask.Name, pr.Name, err)
recorder.Eventf(pr, corev1.EventTypeWarning, "RunsCreationFailed", "Failed to create CustomRuns %q: %v", rpt.CustomRunNames, err)
Copy link
Member

Choose a reason for hiding this comment

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

nit: should this be "CustomRunsCreationFailed"?

Copy link
Member Author

Choose a reason for hiding this comment

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

TBH I am not sure whether people filter on event types-- I wasn't sure if changing this would be backwards compatible

Copy link
Member

Choose a reason for hiding this comment

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

Maybe keep it as is

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label May 30, 2023
@jerop jerop self-assigned this Jun 5, 2023
@tekton-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jerop

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 Jun 8, 2023
@lbernick
Copy link
Member Author

lbernick commented Jun 8, 2023

/hold

want to experiment a bit

@tekton-robot tekton-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jun 8, 2023
@lbernick
Copy link
Member Author

lbernick commented Jun 8, 2023

/hold cancel

@tekton-robot tekton-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jun 8, 2023
@tekton-robot tekton-robot merged commit ee3c22c into tektoncd:main Jun 8, 2023
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/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. lgtm Indicates that a PR is ready to be merged. release-note-none Denotes a PR that doesnt merit a release note. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants