From 0bc42180240e9f57bfa235b100ca991eb5a44cd7 Mon Sep 17 00:00:00 2001 From: Liz MacLean <18120837+lizziemac@users.noreply.github.com> Date: Fri, 9 May 2025 09:01:03 -0400 Subject: [PATCH] Update README.md to have a more explicit callout about timeout-minutes --- README.md | 22 +++++++++++++++++++--- 1 file changed, 19 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 37317e0..4c87544 100644 --- a/README.md +++ b/README.md @@ -108,14 +108,30 @@ jobs: If you'd like to force a timeout of your workflow pause, you can specify `timeout-minutes` at either the [step](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepstimeout-minutes) level or the [job](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idtimeout-minutes) level. +> **Note:** The `timeout-minutes` option has been removed from the `manual-approval` inputs, as it did nothing and incorrectly assured users that they were in fact +> getting timeout behavior. Please use one of the below two approaches instead. +> +> If you are currently using `timeout-minutes` as a `manual-approval` input, you may see a warning, but this will not break your action. + For instance, if you want your manual approval step to timeout after an hour you could do the following: ```yaml -steps: - - uses: trstringer/manual-approval@v1 - timeout-minutes: 60 +jobs: + approval: + steps: + - uses: trstringer/manual-approval@v1 + timeout-minutes: 60 ... ``` +or +```yaml +jobs: + approval: + timeout-minutes: 10 + steps: + - uses: trstringer/manual-approval@v1 + +``` ## Permissions