Skip to content

Commit 919fc19

Browse files
authored
Adding alternative code snippets and unmaintained warning to readme
1 parent 8b67540 commit 919fc19

File tree

1 file changed

+22
-2
lines changed

1 file changed

+22
-2
lines changed

README.md

+22-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,31 @@
11
# GitHub Action for Sleeping 💤
22

3+
## ⚠️ This action is unmaintained.
4+
5+
> This action was published way back in the GitHub Actions beta and is largely abandoned now, mostly because there are much better ways to pause a job than building a whole Docker container on each run (which only works on Linux jobs, too). I highly recommend replacing this action with the following code snippets.
6+
>
7+
> On Linux and macOS runners, use [the `sleep` command](https://linux.die.net/man/1/sleep):
8+
>
9+
```yaml
10+
- name: Sleep for 30 seconds
11+
run: sleep 30s
12+
shell: bash
13+
```
14+
>
15+
> On Windows runners, use [the `Start-Sleep` command](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.utility/start-sleep?view=powershell-7.1):
16+
>
17+
```yaml
18+
- name: Sleep for 30 seconds
19+
run: Start-Sleep -s 30
20+
shell: powershell
21+
```
22+
23+
---
24+
325
This is a very, very simple (and small — only ~1.2 MB thanks to [`busybox`](https://hub.docker.com/_/busybox)) action to wait a specified amount of time before moving on in your workflow.
426

527
Input follows the Linux `sleep` syntax for time units: a number followed by `s` for seconds, `m` for minutes, etc. [Man page for `sleep` here.](https://linux.die.net/man/1/sleep)
628

7-
829
## Usage
930

1031
```yaml
@@ -18,7 +39,6 @@ jobs:
1839
time: '30s'
1940
```
2041

21-
2242
## License
2343

2444
This project is distributed under the [MIT license](LICENSE.md).

0 commit comments

Comments
 (0)