Merge pull request #7 from cytopia/fail-command

Add fail command

Author: cytopia

.github/workflows/test.yml

@@ -4,17 +4,53 @@ on:
   pull_request:
 
 jobs:
-  build:
-    name: test
+  test-default:
+    name: test success
     runs-on: ubuntu-latest
     steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - name: retry
+        uses: ./
+        with:
+          command: true
 
+  test-fail-command-1:
+    name: test fail command 1
+    runs-on: ubuntu-latest
+    steps:
       - name: Checkout repository
         uses: actions/checkout@v3
         with:
           fetch-depth: 0
+      - name: retry
+        uses: ./
+        with:
+          command: false
+          retries: 2
+          pause: 1
+          fail_command: |
+            echo "This command has failed" \
+                && echo "Failed command concatenated"
+        continue-on-error: true
 
+  test-fail-command-2:
+    name: test fail command 2
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
       - name: retry
         uses: ./
         with:
-          command: true
+          command: false
+          retries: 2
+          pause: 1
+          fail_command: |
+            sudo sysctl -w net.ipv4.ip_forward=1 \
+            && sudo systemctl restart docker
+        continue-on-error: true

README.md

@@ -12,12 +12,13 @@ This action allows you to retry shell command for a few times in case they fail.
 
 The following inputs can be used to alter the Docker tag name determination:
 
-| Input     | Required | Default | Description                                |
-|-----------|----------|----------|-------------------------------------------|
-| `retries` | No       | `10`     | How many times to retry on failure.       |
-| `pause`   | No       | `10`     | How many seconds to wait between retries. |
-| `command` | Yes      | ``       | Shell command to execute                  |
-| `workdir` | No       | ``       | Switch to this working directory prior executing the shell command |
+| Input          | Required | Default | Description                                |
+|----------------|----------|----------|-------------------------------------------|
+| `retries`      | No       | `10`     | How many times to retry on failure.       |
+| `pause`        | No       | `10`     | How many seconds to wait between retries. |
+| `command`      | Yes      | ``       | Shell command to execute.                 |
+| `workdir`      | No       | ``       | Switch to this working directory prior executing the shell command. |
+| `fail_command` | No       | ``       | Shell command to execute on every failure of given `command`. |
 
 
 ## :arrow_backward: Outputs
@@ -48,6 +49,12 @@ jobs:
             pause: 10
             command: |
               docker build -t test .
+            # Builing docker sometimes fails on GH Action runner due to network issues.
+            # We ensure that forwarding is reenabled and the daemon is restarted
+            # Before retrying the docker build command
+            fail_command: |
+              sudo sysctl -w net.ipv4.ip_forward=1 \
+              && sudo systemctl restart docker \
 ```
 
 

action.yml

@@ -19,6 +19,10 @@ inputs:
     description: 'Shell command to execute'
     required: true
     default: 'true'
+  fail_command:
+    description: 'Shell command to execute on every failure of given command (The fail_command will always succeed via: || true)'
+    required: false
+    default: ''
   workdir:
     description: 'Switch to this working directory prior executing shell command'
     required: false
@@ -37,6 +41,11 @@ runs:
               echo "[SUCC] ${n}/${RETRIES}";
               return 0;
             fi;
+            if [ -n "${FAIL_COMMAND}" ]; then
+              echo "Executing fail command:";
+              echo "${FAIL_COMMAND}";
+              eval "${FAIL_COMMAND}" || true;
+            fi;
             sleep ${PAUSE};
             echo "[FAIL] ${n}/${RETRIES}";
           done;
@@ -51,3 +60,4 @@ runs:
         PAUSE: ${{ inputs.pause }}
         COMMAND: ${{ inputs.command }}
         WORKDIR: ${{ inputs.workdir }}
+        FAIL_COMMAND: ${{ inputs.fail_command }}