Skip to content

fix(docs): add globalTimeout note to CI documentation - #42535

Closed
Wu Shuwen (dajiaohuang) wants to merge 1 commit into
microsoft:mainfrom
dajiaohuang:fix/42533-globaltimeout-note
Closed

fix(docs): add globalTimeout note to CI documentation#42535
Wu Shuwen (dajiaohuang) wants to merge 1 commit into
microsoft:mainfrom
dajiaohuang:fix/42533-globaltimeout-note

Conversation

@dajiaohuang

Copy link
Copy Markdown

Summary

Fixes #42533

Add a note to the CI documentation explaining the relationship between GitHub Actions' timeout-minutes and Playwright's globalTimeout configuration option.

Problem

The recommended GitHub Actions workflow sets a job-level timeout-minutes but doesn't mention globalTimeout. When a test suite exceeds the job timeout:

  • The run's conclusion is cancelled rather than failure
  • The report upload step is skipped due to the !cancelled() guard
  • Users get no report on precisely the runs where they need it most

Solution

Add a note explaining that setting globalTimeout below the job's timeout-minutes lets Playwright stop itself first, producing a proper failure with a full report instead of a cancelled run.

Fixes microsoft#42533

Add a note explaining the relationship between GitHub Actions
timeout-minutes and Playwright's globalTimeout config option.
@holistis

Copy link
Copy Markdown

This matches the actual failure mode exactly, including the wording. Confirming from having hit this for real: a job with timeout-minutes: 20 and no globalTimeout killed a nightly run of ours 81 out of 164 times, the last 60-plus in a row, every single one ending cancelled with zero report written. Nothing in the run history told us anything was wrong until we went looking.

The note reads correctly to me. Thanks for picking this up and writing the fix.

@dgozman

Copy link
Copy Markdown
Collaborator

Closing in favor of #42563.

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.

Docs: ci.md recommends a job timeout with no globalTimeout, so an over-running suite is cancelled with no report

3 participants