jobs.<job_id>.steps[*].timeout-minutes doesn't describe input < 1, or give examples

[hamirmahal]

Code of Conduct

• I have read and agree to the GitHub Docs project's Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_idstepstimeout-minutes

What part(s) of the article would you like to see updated?

1. The docs should say what happens if users try to set timeout-minutes to a value less than 1, like 0.01.
2. The docs should give correct example usage for that property.

Additional information

No response

[hamirmahal]

For 2, something like

my-job:
 runs-on:         ubuntu-latest
 timeout-minutes: 30

from https://stackoverflow.com/questions/59073731/set-default-timeout-on-github-action-pipeline would work well.

[nguyenalex836]

@hamirmahal Thank you for raising this issue! I'll get this triaged for review ✨ Our team will provide feedback regarding the best next steps for this issue - thanks for your patience! 💛

[hamirmahal]

@nguyenalex836 You're welcome!

[github-actions]

Thanks for opening an issue! We've triaged this issue for technical review by a subject matter expert 👀

[nguyenalex836]

@hamirmahal Thank you so much for your patience while our SME team reviewed! 💛

Upon testing, they found that fractional values are unsupported. They advise to add a note that the value of timeout-minutes needs to be a positive integer value.

I have added the help wanted label so that you, or anyone else, may open a PR to make this update ✨ thank you again for raising this issue!

[hamirmahal]

@nguyenalex836 You're welcome! Would you like any other changes to #34879?

[hamirmahal]

Out of curiosity, where can I find metrics for https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions?

It'd be interesting to see how many views that page gets, and how much usage docs.github.com gets in general.

[nguyenalex836]

@nguyenalex836 You're welcome! Would you like any other changes to #34879?

Your changes look perfect ✨ getting that merged now!

Out of curiosity, where can I find metrics for https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions?

Let me do some digging, and I'll get back to you! 💛