From f1ab7edc62e33ddcd796abf423dcf7ab46035b0c Mon Sep 17 00:00:00 2001
From: "Y.D.X." <73375426+YDX-2147483647@users.noreply.github.com>
Date: Wed, 6 Nov 2024 01:01:39 +0800
Subject: [PATCH] fix: Make `fail: false` effective even when `failIfEmpty:
 true`
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

This commit also makes sure `outputs.exit_code` is “The exit code returned from Lychee”. `failIfEmpty` no longer changes it to `1`.

Relevant docs:
- [Setting exit codes for actions - GitHub Docs](https://docs.github.com/en/actions/sharing-automations/creating-actions/setting-exit-codes-for-actions)
- [exit - POSIX Programmer's Manual](https://manned.org/exit.1posix)

Relates to #86, #128, #145, #245, and #251.
---
 action.yml    | 15 +--------------
 entrypoint.sh | 36 +++++++++++++++++++++++-------------
 2 files changed, 24 insertions(+), 27 deletions(-)

diff --git a/action.yml b/action.yml
index 9402faa..8e1e6e4 100644
--- a/action.yml
+++ b/action.yml
@@ -106,20 +106,7 @@ runs:
 
     - name: Run Lychee
       id: run-lychee
-      run: |
-        # This step runs lychee and captures its exit code.
-        # We use 'set +e' to prevent the script from exiting immediately if lychee fails.
-        # This allows us to capture the exit code and pass it both to GitHub Actions (via GITHUB_OUTPUT)
-        # and to the shell (via the final 'exit $EXIT_CODE').
-        # This ensures that:
-        # 1. The step fails if lychee fails
-        # 2. The exit code is available as an output for subsequent steps
-        # 3. The exit code is properly propagated to the workflow
-        set +e
-        ${{ github.action_path }}/entrypoint.sh
-        EXIT_CODE=$?
-        echo "exit_code=$EXIT_CODE" >> $GITHUB_OUTPUT
-        exit $EXIT_CODE
+      run: ${{ github.action_path }}/entrypoint.sh
       env:
         # https://github.com/actions/runner/issues/665
         INPUT_TOKEN: ${{ inputs.TOKEN }}
diff --git a/entrypoint.sh b/entrypoint.sh
index e5cbb55..7266835 100755
--- a/entrypoint.sh
+++ b/entrypoint.sh
@@ -1,6 +1,13 @@
 #!/bin/bash -l
 set -uo pipefail
 
+# We use ‘set +e’ to prevent the script from exiting immediately if lychee fails.
+# This ensures that:
+# 1. Lychee exit code can be captured and passed to subsequent steps via `$GITHUB_OUTPUT`.
+# 2. This step’s outcome (success/failure) can be controlled according to inputs
+#    by manually calling the ‘exit’ command.
+set +e
+
 # Enable optional debug output
 if [ "${INPUT_DEBUG}" = true ]; then
   echo "Debug output enabled"
@@ -29,19 +36,17 @@ fi
 
 # Execute lychee
 eval lychee ${FORMAT} --output ${LYCHEE_TMP} ${ARGS} 
-exit_code=$?
+LYCHEE_EXIT_CODE=$?
 
-# Overwrite the exit code in case no links were found
-# and `failIfEmpty` is set to `true` (and it is by default)
+# If no links were found and `failIfEmpty` is set to `true` (and it is by default),
+# fail with an error later, but leave lychee exit code untouched.
+should_fail_because_empty=false
 if [ "${INPUT_FAILIFEMPTY}" = "true" ]; then
-    # Explicitly set INPUT_FAIL to true to ensure the script fails
-    # if no links are found
-    INPUT_FAIL=true
     # This is a somewhat crude way to check the Markdown output of lychee
     if grep -E 'Total\s+\|\s+0' "${LYCHEE_TMP}"; then
         echo "No links were found. This usually indicates a configuration error." >> "${LYCHEE_TMP}"
         echo "If this was expected, set 'failIfEmpty: false' in the args." >> "${LYCHEE_TMP}"
-        exit_code=1
+        should_fail_because_empty=true
     fi
 fi
 
@@ -67,12 +72,17 @@ if [ "${INPUT_FORMAT}" == "markdown" ]; then
   fi
 fi
 
-# Pass lychee exit code to next step
-echo "exit_code=$exit_code" >> $GITHUB_OUTPUT
+# Pass lychee exit code to subsequent steps
+echo "exit_code=$LYCHEE_EXIT_CODE" >> "$GITHUB_OUTPUT"
 
-# If `fail` is set to `true` (and it is by default), propagate the real exit
-# value to the workflow runner. This will cause the pipeline to fail on 
-# `exit != # 0`.
+# Determine the outcome of this step
+# Exiting with a nonzero value will fail the pipeline, but the specific value
+# does not matter. (GitHub does not share it with subsequent steps for composite actions.)
 if [ "$INPUT_FAIL" = true ] ; then
-    exit ${exit_code}
+  # If `fail` is set to `true` (and it is by default), propagate lychee exit code
+  exit ${LYCHEE_EXIT_CODE}
+fi
+if [ "$should_fail_because_empty" = true ] ; then
+  # If we decided previously to fail because no links were found, fail
+  exit 1
 fi