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

Inconsistency of Required v.s. Optional fields across docs. #5818

Closed
chuangw6 opened this issue Nov 30, 2022 · 0 comments · Fixed by #5819
Closed

Inconsistency of Required v.s. Optional fields across docs. #5818

chuangw6 opened this issue Nov 30, 2022 · 0 comments · Fixed by #5819
Labels
kind/bug Categorizes issue or PR as related to a bug.

Comments

@chuangw6
Copy link
Member

Expected Behavior

Required fields v.s. optional fields in PipelineRun status should be consistent across documentations.

Actual Behavior

docs/pipelinerun.md documents that startTime and completionTime are required fields in PipelineRun status, but the docs/pipeline-api.md says those fields are optional.

Steps to Reproduce the Problem

N/A

@chuangw6 chuangw6 added the kind/bug Categorizes issue or PR as related to a bug. label Nov 30, 2022
chuangw6 added a commit to chuangw6/pipeline that referenced this issue Nov 30, 2022
Fixes tektoncd#5818.

Prior, `startTime` and `completionTime` are marked as optional fields in Run
status, and `provenance` field was not marked as optional in Run status.

Now, we remove `+optional` tag for `startTime` and `completionTime` in Run
status, and add `+optional` tag for the `provenance` field.

Signed-off-by: Chuang Wang <[email protected]>
Repository owner moved this from Todo to Done in Tekton Community Roadmap Dec 23, 2022
tekton-robot pushed a commit that referenced this issue Dec 23, 2022
Fixes #5818.

Prior, `startTime` and `completionTime` are marked as optional fields in Run
status, and `provenance` field was not marked as optional in Run status.

Now, we remove `+optional` tag for `startTime` and `completionTime` in Run
status, and add `+optional` tag for the `provenance` field.

Signed-off-by: Chuang Wang <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/bug Categorizes issue or PR as related to a bug.
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

1 participant