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.

Sign up for GitHub

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

Jump to bottom

Add PipelineRun pipeline-timeout note to pipeline docs #8510

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add PipelineRun pipeline-timeout note to pipeline docs #8510

wants to merge 1 commit into from

Conversation

aThorp96
Copy link
Contributor

@aThorp96 aThorp96 commented Jan 20, 2025 •
edited
Loading

Changes

The Pipelines docs' timeout section did not mention that the Pipeline itself had its timeout configured by the PipelineRun, causing some confusion in #8114. Without adding a whole section, linking to the PipelineRun timeout docs in a note about Task vs Pipeline timeout precedence both documents where the pipeline timeout is configured while also clarifying the misconception of timeout precedence.

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
  • pre-commit Passed
  • 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

@aThorp96
Add PipelineRun pipeline-timeout note to pipeline docs
4c59923 
The Pipelines docs' timeout section did not mention that the Pipeline
itself had its timeout configured by the PipelineRun, causing some
confusion in tektoncd#8114. Without adding a whole section, linking to the
PipelineRun timeout docs in a note about Task vs Pipeline timeout
precedence both documents where the pipeline timeout is configured
while also clarifying the misconception of timeout precedence.
@tekton-robot tekton-robot added the release-note-none Denotes a PR that doesnt merit a release note. label Jan 20, 2025
@tekton-robot tekton-robot added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jan 20, 2025
@tekton-robot
Copy link
Collaborator

Hi @aThorp96. Thanks for your PR.

I'm waiting for a tektoncd member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@aThorp96
Copy link
Contributor Author

/kind documentation

@tekton-robot tekton-robot added the kind/documentation Categorizes issue or PR as related to documentation. label Jan 20, 2025
vdemeester
vdemeester approved these changes Jan 20, 2025
View reviewed changes
Copy link
Member

@vdemeester vdemeester left a comment

Choose a reason for hiding this comment

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

/ok-to-test

@tekton-robot tekton-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jan 20, 2025
@tekton-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: vdemeester

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 Jan 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vdemeester vdemeester vdemeester approved these changes

@abayer abayer Awaiting requested review from abayer

Assignees
No one assigned
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/documentation Categorizes issue or PR as related to documentation. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. release-note-none Denotes a PR that doesnt merit a release note. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
Tekton Community Roadmap
Status: Todo
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@aThorp96 @tekton-robot @vdemeester