From b4be356972b97e1500a2e8cee4cbc5153158fdc6 Mon Sep 17 00:00:00 2001 From: Christopher Fenner <26137398+CCFenner@users.noreply.github.com> Date: Tue, 26 May 2020 23:53:21 +0200 Subject: [PATCH] fix MD040 & MD041 --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 4891736..7bd323a 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ -## wait-for-it +# wait-for-it `wait-for-it.sh` is a pure bash script that will wait on the availability of a host and TCP port. It is useful for synchronizing the spin-up of interdependent services, such as linked docker containers. Since it is a pure bash script, it does not have any external dependencies. ## Usage -``` +```sh wait-for-it.sh host:port [-s] [-t timeout] [-- command args] -h HOST | --host=HOST Host or IP under test -p PORT | --port=PORT TCP port under test @@ -20,7 +20,7 @@ wait-for-it.sh host:port [-s] [-t timeout] [-- command args] For example, let's test to see if we can access port 80 on www.google.com, and if it is available, echo the message `google is up`. -``` +```sh $ ./wait-for-it.sh www.google.com:80 -- echo "google is up" wait-for-it.sh: waiting 15 seconds for www.google.com:80 wait-for-it.sh: www.google.com:80 is available after 0 seconds @@ -29,7 +29,7 @@ google is up You can set your own timeout with the `-t` or `--timeout=` option. Setting the timeout value to 0 will disable the timeout: -``` +```sh $ ./wait-for-it.sh -t 0 www.google.com:80 -- echo "google is up" wait-for-it.sh: waiting for www.google.com:80 without a timeout wait-for-it.sh: www.google.com:80 is available after 0 seconds @@ -38,7 +38,7 @@ google is up The subcommand will be executed regardless if the service is up or not. If you wish to execute the subcommand only if the service is up, add the `--strict` argument. In this example, we will test port 81 on www.google.com which will fail: -``` +```sh $ ./wait-for-it.sh www.google.com:81 --timeout=1 --strict -- echo "google is up" wait-for-it.sh: waiting 1 seconds for www.google.com:81 wait-for-it.sh: timeout occurred after waiting 1 seconds for www.google.com:81 @@ -47,7 +47,7 @@ wait-for-it.sh: strict mode, refusing to execute subprocess If you don't want to execute a subcommand, leave off the `--` argument. This way, you can test the exit condition of `wait-for-it.sh` in your own scripts, and determine how to proceed: -``` +```sh $ ./wait-for-it.sh www.google.com:80 wait-for-it.sh: waiting 15 seconds for www.google.com:80 wait-for-it.sh: www.google.com:80 is available after 0 seconds