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

Remove docstrings indicating that there is a 24h limit on timeouts #6585

Merged
merged 1 commit into from
May 1, 2023

Conversation

jerop
Copy link
Member

@jerop jerop commented Apr 26, 2023

Changes

Prior to this change, docstrings for timeouts indicated that they should not be higher than 24h. There is no such enforced limit, in fact we allow setting timeouts to 0 which means that there will be no timeout and the Run will execute until it completes successfully or fails from an error.

This commit makes the following changes:

  • Removes the 24h limit for timeouts in docstrings
  • Adds tests where timeout is set to 24h and higher

Submitter Checklist

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

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

Release Notes

NONE

/kind cleanup

Prior to this change, docstrings for timeouts indicated that they
should not be higher than 24h. There is no such enforced limit, in
fact we allow setting timeouts to 0 which means that there will be
no timeout and the Run will execute until it completes successfully
or fails from an error.

This commit makes the following changes:
- Removes the 24h limit for timeouts in docstrings
- Adds tests where timeout is set to 24h and higher
@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. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Apr 26, 2023
Copy link
Member

@lbernick lbernick left a comment

Choose a reason for hiding this comment

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

thanks Jerop! looks like these docstrings were introduced in #463 (for taskruns) and #2038 (for pipelinetasks) but I don't see any reason for these comments or validation of the 24h limit.

@tekton-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: lbernick

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 Apr 26, 2023
@jerop jerop added this to the Pipelines v0.48 milestone Apr 28, 2023
@Yongxuanzhang
Copy link
Member

/lgtm
Thanks for adding the tests!

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label May 1, 2023
@tekton-robot tekton-robot merged commit a0fb784 into tektoncd:main May 1, 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/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.

4 participants