Skip to content

Conversation

alauda-github-idpbot
Copy link
Collaborator

@alauda-github-idpbot alauda-github-idpbot commented Aug 21, 2025

auto update doc build config for doc pipeline

Summary by CodeRabbit

  • Chores
    • Increased the documentation build pipeline timeout from 1 hour to 2 hours to reduce timeout-related failures during longer doc builds.
    • Expect more consistent publication of updated documentation after releases.
    • No changes to product features or APIs; end-user functionality remains the same.
    • No action required from users; this change affects only the build infrastructure.

Copy link

coderabbitai bot commented Aug 21, 2025

Walkthrough

Increases the pipeline timeout in .builds/doc-build.yaml from 1 hour to 2 hours within spec.runTemplate.spec.timeouts. No other changes.

Changes

Cohort / File(s) Summary
CI pipeline timeout update
./.builds/doc-build.yaml
Updated spec.runTemplate.spec.timeouts from 1h to 2h

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

I nudge the clock with gentle might,
Two hops longer through the night—
Docs now brew without a hurry,
Pipelines stretch, no need to worry.
Thump-thump! More time to build it right.

Tip

🔌 Remote MCP (Model Context Protocol) integration is now available!

Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats.

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch feat/auto-update-doc-build-master

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
.builds/doc-build.yaml (1)

6-8: Consider explicitly setting tasks/finally timeouts to avoid abrupt cancellation of cleanups.

If the whole pipeline gets 2h, it’s often useful to reserve a few minutes for finally steps and constrain task runs. This helps ensure finalizers still execute even when tasks approach the overall cap.

Suggested tweak:

       timeouts:
-        pipeline: 2h
+        pipeline: "2h"
+        tasks: "1h55m"
+        finally: "5m"
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 76526cb and 1506ad5.

📒 Files selected for processing (1)
  • .builds/doc-build.yaml (1 hunks)
🔇 Additional comments (2)
.builds/doc-build.yaml (2)

7-7: LGTM: Timeout bump to 2h is straightforward and aligns with the PR intent.

No structural or schema red flags in this line; value reads as a Go-style duration and should be acceptable by the controller assuming compatible Tekton/Katanomi versions.


7-7: Confirm Tekton timeout syntax and cluster defaults

Tekton parses Go duration strings directly, so unquoted 2h is valid, but it’s best practice to quote values in YAML (e.g.,

spec:
  runTemplate:
    spec:
      timeouts:
        pipeline: "2h"

or "2h0m0s") to avoid any YAML parsing edge cases.

  • Ensure your PipelineRun actually contains that timeout field (run kubectl get pipelinerun <name> -o yaml and look for spec.timeouts.pipeline).
  • Tekton’s default-timeout-minutes (in the config-defaults ConfigMap in namespace tekton-pipelines, or via the operator’s TektonConfig) defaults to 60 minutes when no timeout is set explicitly. You can raise this default by editing that ConfigMap or CR.
  • There’s no hard-coded 1 hour cap—longer durations (e.g., "2h30m0s") are honored if they’re set. If you still see 1 hour timeouts, verify your Tekton version and check for any admission controllers or tooling (Katanomi/Triggers/Dashboard/CLI) that might be stripping or overriding the timeout.

Please update your .builds/doc-build.yaml accordingly and verify on-cluster behavior.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant