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

Make user-facing PipelineRun condition messages more granular and debuggable as canonical error codes #7501

Open
JeromeJu opened this issue Dec 18, 2023 · 0 comments
Labels
kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. kind/question Issues or PRs that are questions around the project or a particular feature

Comments

@JeromeJu
Copy link
Member

JeromeJu commented Dec 18, 2023

User requirements

Following up on the discussion at #6859, a mechanism of canonical error code would be preferred for error attribution for downstream users.

Current behavior

Currently, the most similar field we have during a Run status is the PipelineRun/TaskRun reason. But
For example, PipelineValidationFailed is vague in terms of it conflates many reasons i.e. invalid param array index and invalid PipelineResult see #7434 for more detail.

The following table summarizes the PipelineRunReasons that have conflated error causes:

PipelineRunReason Is PipelineRunReason conflated
CreateRunFailed This could be broken down into more granular reasons of why the Taskrun/CustomRun creation failed, but why did we not make this the case remains questionable.
PipelineValidationFailed Decompose conflated user-facing PipelineRunStatus/ TaskRunStatus failure reasons
InvalidTaskResultReference Before taskruns are run, this shall be InvalidPipelineResultReference instead of TaskResult
InvalidPipelineResourceBindings This is not used anymore, consider removing once v1beta1 deprecated.

The remaining questions are similar to what's discussed at #7390 , how we could not break users with such changes.

Future Work Plan

  • Transform Run Condition Reasons to be debuggable as canonical error codes.

/kind question
/kind cleanup

@tekton-robot tekton-robot added kind/question Issues or PRs that are questions around the project or a particular feature kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. labels Dec 18, 2023
@JeromeJu JeromeJu changed the title Make user-facing condition messages more granular like canonical error codes Make user-facing condition messages more granular as canonical error codes Dec 28, 2023
@JeromeJu JeromeJu changed the title Make user-facing condition messages more granular as canonical error codes Make user-facing PipelineRun condition messages more granular as canonical error codes Dec 28, 2023
@JeromeJu JeromeJu changed the title Make user-facing PipelineRun condition messages more granular as canonical error codes Make user-facing PipelineRun condition messages more granular and debuggable as canonical error codes Jan 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. kind/question Issues or PRs that are questions around the project or a particular feature
Projects
None yet
Development

No branches or pull requests

2 participants