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

Update timeout support for CreatePipelineRun and CreateTaskRun #2616

Merged
merged 1 commit into from
Dec 5, 2022

Conversation

AlanGreene
Copy link
Member

Changes

PipelineRun.spec.timeout was deprecated in Pipelines v0.36.0, and replaced with a new PipelineRun.spec.timeouts which allows setting timeouts for the entire pipeline, for its tasks, for finally tasks, or any combination of these.

Update the UI to provide the additional input fields for the new values and remove the existing validation as these fields are not specified as numeric values representing minutes, instead they support a duration syntax provided by Go's ParseDuration, e.g. 1h20m30s.

Update the CreateTaskRun page to support this format too instead of restricting the user to entering minutes.

Fix some redundant 'optional' labels on input fields.

/kind feature

Submitter Checklist

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

  • Docs included if any changes are user facing
  • 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 (new features, significant UI changes, API changes, bug fixes, changes requiring upgrade notices or deprecation warnings)
  • Release notes contains the string "action required" if the change requires additional action from users switching to the new release

Release Notes

Update the timeout field on the Create PipelineRun and Create TaskRun pages to support the duration format, e.g. `1h20m30s`. Add support on the Create PipelineRun page for the `timeouts.pipeline`, `timeouts.tasks`, and `timeouts.finally` fields introduced in Pipelines v0.36.0.

`PipelineRun.spec.timeout` was deprecated in Pipelines v0.36.0, and
replaced with a new `PipelineRun.spec.timeouts` which allows setting
timeouts for the entire `pipeline`, for its `tasks`, for `finally` tasks,
or any combination of these.

Update the UI to provide the additional input fields for the new
values and remove the existing validation as these fields are not
specified as numeric values representing minutes, instead they support
a duration syntax provided by Go's `ParseDuration`, e.g. `1h20m30s`.

Update the CreateTaskRun page to support this format too instead of
restricting the user to entering minutes.

Fix some redundant 'optional' labels on input fields.
@tekton-robot tekton-robot added kind/feature Categorizes issue or PR as related to a new feature. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Dec 2, 2022
Copy link
Contributor

@briangleeson briangleeson left a comment

Choose a reason for hiding this comment

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

I see there's no validation on timeouts or helper text. Format looks to be like 0h0m60s, so not sure what happens if you provide a bad value? Worth validating by regex or adding help text for the format?

@AlanGreene
Copy link
Member Author

Validation is performed by the Tekton controller and returned in a notification on the page. There's more to the validation than just the format as certain combinations of values are not allowed, also depending on the default global config.

Copy link
Contributor

@briangleeson briangleeson left a comment

Choose a reason for hiding this comment

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

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Dec 5, 2022
@tekton-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: briangleeson

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 Dec 5, 2022
@tekton-robot tekton-robot merged commit 4c29282 into tektoncd:main Dec 5, 2022
@AlanGreene AlanGreene deleted the timeouts branch December 5, 2022 11:26
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/feature Categorizes issue or PR as related to a new feature. lgtm Indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants