From d5842c1cfe18c56fbf0c7f39436b4b55fde0623b Mon Sep 17 00:00:00 2001 From: per1234 Date: Wed, 11 Aug 2021 03:38:58 -0700 Subject: [PATCH] Enhance "Check License" workflow's error output The use of the `error` workflow command will cause the important error message output to be surfaced prominently in the workflow run summary and log. The workflow run logs can be somewhat labyrinthine to those who don't work with them regularly, so finding the previous output to determine what caused the failure might have been challenging. --- .github/workflows/check-license.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/check-license.yml b/.github/workflows/check-license.yml index 167a6973..d51ff956 100644 --- a/.github/workflows/check-license.yml +++ b/.github/workflows/check-license.yml @@ -53,14 +53,14 @@ jobs: DETECTED_LICENSE_FILE="$(echo "$LICENSEE_OUTPUT" | jq .matched_files[0].filename | tr --delete '\r')" echo "Detected license file: $DETECTED_LICENSE_FILE" if [ "$DETECTED_LICENSE_FILE" != "\"${EXPECTED_LICENSE_FILENAME}\"" ]; then - echo "ERROR: detected license file doesn't match expected: $EXPECTED_LICENSE_FILENAME" + echo "::error file=${DETECTED_LICENSE_FILE}::detected license file $DETECTED_LICENSE_FILE doesn't match expected: $EXPECTED_LICENSE_FILENAME" EXIT_STATUS=1 fi DETECTED_LICENSE_TYPE="$(echo "$LICENSEE_OUTPUT" | jq .matched_files[0].matched_license | tr --delete '\r')" echo "Detected license type: $DETECTED_LICENSE_TYPE" if [ "$DETECTED_LICENSE_TYPE" != "\"${EXPECTED_LICENSE_TYPE}\"" ]; then - echo "ERROR: detected license type doesn't match expected $EXPECTED_LICENSE_TYPE" + echo "::error file=${DETECTED_LICENSE_FILE}::detected license type $DETECTED_LICENSE_TYPE doesn't match expected \"${EXPECTED_LICENSE_TYPE}\"" EXIT_STATUS=1 fi