From ddbc96bd23afb1333eacb0005555323adde8973d Mon Sep 17 00:00:00 2001 From: Victor Martinez Date: Tue, 23 Jun 2020 15:25:12 +0100 Subject: [PATCH 1/9] Support TAP reporting format --- .gitignore | 3 +++ Dockerfile | 4 +++- README.md | 2 ++ lib/linter.sh | 62 +++++++++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 70 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index ad46b308..26f92ccf 100644 --- a/.gitignore +++ b/.gitignore @@ -59,3 +59,6 @@ typings/ # next.js build output .next + +# default output report +super-linter.report \ No newline at end of file diff --git a/Dockerfile b/Dockerfile index 78f9aea8..50b13f30 100644 --- a/Dockerfile +++ b/Dockerfile @@ -171,7 +171,9 @@ ENV GITHUB_SHA=${GITHUB_SHA} \ RUN_LOCAL=${RUN_LOCAL} \ TEST_CASE_RUN=${TEST_CASE_RUN} \ ACTIONS_RUNNER_DEBUG=${ACTIONS_RUNNER_DEBUG} \ - DISABLE_ERRORS=${DISABLE_ERRORS} + DISABLE_ERRORS=${DISABLE_ERRORS} \ + OUTPUT_FORMAT=${OUTPUT_FORMAT} \ + OUTPUT_FOLDER=${OUTPUT_FOLDER} ############################# # Copy scripts to container # diff --git a/README.md b/README.md index 5cc133b3..db767737 100644 --- a/README.md +++ b/README.md @@ -147,6 +147,8 @@ and won't run anything unexpected. | **ACTIONS_RUNNER_DEBUG** | `false` | Flag to enable additional information about the linter, versions, and additional output. | | **DISABLE_ERRORS** | `false` | Flag to have the linter complete with exit code 0 even if errors were detected. | | **DEFAULT_WORKSPACE** | `/tmp/lint` | The location containing files to lint if you are running locally. | +| **OUTPUT_FORMAT** | `` | The report format to be generated, besides the stdout one. Supported formats: tap | +| **OUTPUT_FOLDER** | `super-linter.report` | The location where the output reporting will be generated to. | ### Template rules files You can use the **GitHub** **Super-Linter** *with* or *without* your own personal rules sets. This allows for greater flexibility for each individual code base. The Template rules all try to follow the standards we believe should be enabled at the basic level. diff --git a/lib/linter.sh b/lib/linter.sh index 862adf9a..12826889 100755 --- a/lib/linter.sh +++ b/lib/linter.sh @@ -125,6 +125,13 @@ READ_ONLY_CHANGE_FLAG=0 # Flag set to 1 if files c TEST_CASE_FOLDER='.automation/test' # Folder for test cases we should always ignore DEFAULT_DISABLE_ERRORS='false' # Default to enabling errors +############## +# Format # +############## +OUTPUT_FORMAT="${OUTPUT_FORMAT}" # Output format to be generated. Default none +OUTPUT_FOLDER="${OUTPUT_FOLDER:-super-linter.report}" # Folder where the reports are generated. Default super-linter.report +REPORT_OUTPUT_FOLDER="${DEFAULT_WORKSPACE}/${OUTPUT_FOLDER}" + ########################## # Array of changed files # ########################## @@ -1782,6 +1789,16 @@ LintCodebase() echo "$LINE" done + #################################### + # Prepare context if OUTPUT_FORMAT # + #################################### + if [ -n "${OUTPUT_FORMAT}" ] ; then + TMPFILE=$(mktemp -q /tmp/super-linter.XXXXXX) + INDEX=0 + mkdir -p "${REPORT_OUTPUT_FOLDER}" + REPORT_OUTPUT_FILE="${REPORT_OUTPUT_FOLDER}/super-linter-${FILE_TYPE}.${OUTPUT_FORMAT}" + fi + ################## # Lint the files # ################## @@ -1803,6 +1820,8 @@ LintCodebase() continue fi + (("INDEX++")) + ############## # File print # ############## @@ -1846,13 +1865,37 @@ LintCodebase() echo "ERROR:[$LINT_CMD]" # Increment the error count (("ERRORS_FOUND_$FILE_TYPE++")) + + ####################################################### + # Store the linting as a temporary file in TAP format # + ####################################################### + if [ -n "${OUTPUT_FORMAT}" ] ; then + echo "nok ok ${INDEX} - ${FILE}" >> "${TMPFILE}" + echo " ERROR:[$LINT_CMD]" >> "${TMPFILE}" + fi + else ########### # Success # ########### echo " - File:[$FILE_NAME] was linted with [$LINTER_NAME] successfully" + + ####################################################### + # Store the linting as a temporary file in TAP format # + ####################################################### + if [ -n "${OUTPUT_FORMAT}" ] ; then + echo "ok ${INDEX} - ${FILE}" >> "${TMPFILE}" + fi fi done + + ################################# + # Generate report in TAP format # + ################################# + if [ -n "${OUTPUT_FORMAT}" ] && [ ${INDEX} -gt 0 ] ; then + echo "1..${INDEX}" > "${REPORT_OUTPUT_FILE}" + cat "${TMPFILE}" >> "${REPORT_OUTPUT_FILE}" + fi fi } ################################################################################ @@ -2073,6 +2116,14 @@ Footer() echo "----------------------------------------------" echo "" + + ################################### + # Prints output report if enabled # + ################################### + if [ -z "${FORMAT_REPORT}" ] ; then + echo "Reports generated in folder ${REPORT_OUTPUT_FOLDER}" + fi + ############################## # Prints for errors if found # ############################## @@ -2201,6 +2252,17 @@ RunTestCases() ########## Header +############################################################## +# check flag for validating the report folder does not exist # +############################################################## +if [ -n "${OUTPUT_FORMAT}" ]; then + if [ -d "${REPORT_OUTPUT_FOLDER}" ] ; then + echo "ERROR! Found ${REPORT_OUTPUT_FOLDER}" + echo "Please remove the folder and try again." + exit 1 + fi +fi + ####################### # Get GitHub Env Vars # ####################### From 40687fc6db845f5bdec8d46c8a6e3cac5b8b799e Mon Sep 17 00:00:00 2001 From: Victor Martinez Date: Tue, 23 Jun 2020 15:40:43 +0100 Subject: [PATCH 2/9] Enable ansible linter in TAP format --- lib/linter.sh | 44 +++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 43 insertions(+), 1 deletion(-) diff --git a/lib/linter.sh b/lib/linter.sh index 12826889..73c632c6 100755 --- a/lib/linter.sh +++ b/lib/linter.sh @@ -497,6 +497,16 @@ LintAnsibleFiles() done fi + #################################### + # Prepare context if OUTPUT_FORMAT # + #################################### + if [ -n "${OUTPUT_FORMAT}" ] ; then + TMPFILE=$(mktemp -q "/tmp/super-linter-${FILE_TYPE}.XXXXXX") + INDEX=0 + mkdir -p "${REPORT_OUTPUT_FOLDER}" + REPORT_OUTPUT_FILE="${REPORT_OUTPUT_FOLDER}/super-linter-${FILE_TYPE}.${OUTPUT_FORMAT}" + fi + ################## # Lint the files # ################## @@ -511,6 +521,11 @@ LintAnsibleFiles() continue fi + ################################## + # Increase the linted file index # + ################################## + (("INDEX++")) + #################### # Get the filename # #################### @@ -543,13 +558,37 @@ LintAnsibleFiles() echo "ERROR:[$LINT_CMD]" # Increment error count ((ERRORS_FOUND_ANSIBLE++)) + + ####################################################### + # Store the linting as a temporary file in TAP format # + ####################################################### + if [ -n "${OUTPUT_FORMAT}" ] ; then + echo "nok ok ${INDEX} - ${FILE}" >> "${TMPFILE}" + echo " ERROR:[$LINT_CMD]" >> "${TMPFILE}" + fi else ########### # Success # ########### echo " - File:[$FILE_NAME] was linted with [$LINTER_NAME] successfully" + + ####################################################### + # Store the linting as a temporary file in TAP format # + ####################################################### + if [ -n "${OUTPUT_FORMAT}" ] ; then + echo "ok ${INDEX} - ${FILE}" >> "${TMPFILE}" + fi fi done + + ################################# + # Generate report in TAP format # + ################################# + if [ -n "${OUTPUT_FORMAT}" ] && [ ${INDEX} -gt 0 ] ; then + echo "1..${INDEX}" > "${REPORT_OUTPUT_FILE}" + cat "${TMPFILE}" >> "${REPORT_OUTPUT_FILE}" + fi + else # No ansible directory found in path ############################### # Check to see if debug is on # @@ -1793,7 +1832,7 @@ LintCodebase() # Prepare context if OUTPUT_FORMAT # #################################### if [ -n "${OUTPUT_FORMAT}" ] ; then - TMPFILE=$(mktemp -q /tmp/super-linter.XXXXXX) + TMPFILE=$(mktemp -q "/tmp/super-linter-${FILE_TYPE}.XXXXXX") INDEX=0 mkdir -p "${REPORT_OUTPUT_FOLDER}" REPORT_OUTPUT_FILE="${REPORT_OUTPUT_FOLDER}/super-linter-${FILE_TYPE}.${OUTPUT_FORMAT}" @@ -1820,6 +1859,9 @@ LintCodebase() continue fi + ################################## + # Increase the linted file index # + ################################## (("INDEX++")) ############## From 6b1635490139cb104fcc205ac67b8c8b86d47c9a Mon Sep 17 00:00:00 2001 From: Victor Martinez Date: Wed, 24 Jun 2020 22:45:44 +0100 Subject: [PATCH 3/9] TAP Format --- lib/linter.sh | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/linter.sh b/lib/linter.sh index 73c632c6..9f7a8c96 100755 --- a/lib/linter.sh +++ b/lib/linter.sh @@ -564,7 +564,7 @@ LintAnsibleFiles() ####################################################### if [ -n "${OUTPUT_FORMAT}" ] ; then echo "nok ok ${INDEX} - ${FILE}" >> "${TMPFILE}" - echo " ERROR:[$LINT_CMD]" >> "${TMPFILE}" + printf " ---\n but:[%s]\n ..." "$LINT_CMD" >> "${TMPFILE}" fi else ########### @@ -1913,7 +1913,7 @@ LintCodebase() ####################################################### if [ -n "${OUTPUT_FORMAT}" ] ; then echo "nok ok ${INDEX} - ${FILE}" >> "${TMPFILE}" - echo " ERROR:[$LINT_CMD]" >> "${TMPFILE}" + printf " ---\n but:[%s]\n ..." "$LINT_CMD" >> "${TMPFILE}" fi else From c26c3ddf8eb19d85b9de1165e21ad4097781e0bf Mon Sep 17 00:00:00 2001 From: Victor Martinez Date: Wed, 24 Jun 2020 22:49:12 +0100 Subject: [PATCH 4/9] TAP 13 specification See https://testanything.org/tap-version-13-specification.html --- lib/linter.sh | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/linter.sh b/lib/linter.sh index 9f7a8c96..32604fb9 100755 --- a/lib/linter.sh +++ b/lib/linter.sh @@ -564,7 +564,7 @@ LintAnsibleFiles() ####################################################### if [ -n "${OUTPUT_FORMAT}" ] ; then echo "nok ok ${INDEX} - ${FILE}" >> "${TMPFILE}" - printf " ---\n but:[%s]\n ..." "$LINT_CMD" >> "${TMPFILE}" + printf " ---\n message:[%s]\n ..." "$LINT_CMD" >> "${TMPFILE}" fi else ########### @@ -585,7 +585,7 @@ LintAnsibleFiles() # Generate report in TAP format # ################################# if [ -n "${OUTPUT_FORMAT}" ] && [ ${INDEX} -gt 0 ] ; then - echo "1..${INDEX}" > "${REPORT_OUTPUT_FILE}" + printf "TAP version 13\n1..%s" "${INDEX}" > "${REPORT_OUTPUT_FILE}" cat "${TMPFILE}" >> "${REPORT_OUTPUT_FILE}" fi @@ -1913,7 +1913,7 @@ LintCodebase() ####################################################### if [ -n "${OUTPUT_FORMAT}" ] ; then echo "nok ok ${INDEX} - ${FILE}" >> "${TMPFILE}" - printf " ---\n but:[%s]\n ..." "$LINT_CMD" >> "${TMPFILE}" + printf " ---\n message:[%s]\n ..." "$LINT_CMD" >> "${TMPFILE}" fi else @@ -1935,7 +1935,7 @@ LintCodebase() # Generate report in TAP format # ################################# if [ -n "${OUTPUT_FORMAT}" ] && [ ${INDEX} -gt 0 ] ; then - echo "1..${INDEX}" > "${REPORT_OUTPUT_FILE}" + printf "TAP version 13\n1..%s" "${INDEX}" > "${REPORT_OUTPUT_FILE}" cat "${TMPFILE}" >> "${REPORT_OUTPUT_FILE}" fi fi From dd3a792f27ae1a8c3e33b12e4d1b0621e118254b Mon Sep 17 00:00:00 2001 From: Victor Martinez Date: Wed, 24 Jun 2020 22:58:45 +0100 Subject: [PATCH 5/9] Use isTap function and fix the output format --- lib/linter.sh | 30 ++++++++++++++++++++---------- 1 file changed, 20 insertions(+), 10 deletions(-) diff --git a/lib/linter.sh b/lib/linter.sh index 32604fb9..a48f8bbe 100755 --- a/lib/linter.sh +++ b/lib/linter.sh @@ -500,7 +500,7 @@ LintAnsibleFiles() #################################### # Prepare context if OUTPUT_FORMAT # #################################### - if [ -n "${OUTPUT_FORMAT}" ] ; then + if IsTAP ; then TMPFILE=$(mktemp -q "/tmp/super-linter-${FILE_TYPE}.XXXXXX") INDEX=0 mkdir -p "${REPORT_OUTPUT_FOLDER}" @@ -562,7 +562,7 @@ LintAnsibleFiles() ####################################################### # Store the linting as a temporary file in TAP format # ####################################################### - if [ -n "${OUTPUT_FORMAT}" ] ; then + if IsTAP ; then echo "nok ok ${INDEX} - ${FILE}" >> "${TMPFILE}" printf " ---\n message:[%s]\n ..." "$LINT_CMD" >> "${TMPFILE}" fi @@ -575,7 +575,7 @@ LintAnsibleFiles() ####################################################### # Store the linting as a temporary file in TAP format # ####################################################### - if [ -n "${OUTPUT_FORMAT}" ] ; then + if IsTAP ; then echo "ok ${INDEX} - ${FILE}" >> "${TMPFILE}" fi fi @@ -584,8 +584,8 @@ LintAnsibleFiles() ################################# # Generate report in TAP format # ################################# - if [ -n "${OUTPUT_FORMAT}" ] && [ ${INDEX} -gt 0 ] ; then - printf "TAP version 13\n1..%s" "${INDEX}" > "${REPORT_OUTPUT_FILE}" + if IsTAP && [ ${INDEX} -gt 0 ] ; then + printf "TAP version 13\n1..%s\n" "${INDEX}" > "${REPORT_OUTPUT_FILE}" cat "${TMPFILE}" >> "${REPORT_OUTPUT_FILE}" fi @@ -1831,7 +1831,7 @@ LintCodebase() #################################### # Prepare context if OUTPUT_FORMAT # #################################### - if [ -n "${OUTPUT_FORMAT}" ] ; then + if IsTAP ; then TMPFILE=$(mktemp -q "/tmp/super-linter-${FILE_TYPE}.XXXXXX") INDEX=0 mkdir -p "${REPORT_OUTPUT_FOLDER}" @@ -1911,7 +1911,7 @@ LintCodebase() ####################################################### # Store the linting as a temporary file in TAP format # ####################################################### - if [ -n "${OUTPUT_FORMAT}" ] ; then + if IsTAP ; then echo "nok ok ${INDEX} - ${FILE}" >> "${TMPFILE}" printf " ---\n message:[%s]\n ..." "$LINT_CMD" >> "${TMPFILE}" fi @@ -1925,7 +1925,7 @@ LintCodebase() ####################################################### # Store the linting as a temporary file in TAP format # ####################################################### - if [ -n "${OUTPUT_FORMAT}" ] ; then + if IsTAP ; then echo "ok ${INDEX} - ${FILE}" >> "${TMPFILE}" fi fi @@ -1934,8 +1934,8 @@ LintCodebase() ################################# # Generate report in TAP format # ################################# - if [ -n "${OUTPUT_FORMAT}" ] && [ ${INDEX} -gt 0 ] ; then - printf "TAP version 13\n1..%s" "${INDEX}" > "${REPORT_OUTPUT_FILE}" + if IsTAP && [ ${INDEX} -gt 0 ] ; then + printf "TAP version 13\n1..%s\n" "${INDEX}" > "${REPORT_OUTPUT_FILE}" cat "${TMPFILE}" >> "${REPORT_OUTPUT_FILE}" fi fi @@ -2286,6 +2286,16 @@ RunTestCases() Footer } ################################################################################ +#### Function IsTap ############################################################ +IsTAP() +{ + if [ "${OUTPUT_FORMAT}" == "tap" ] ; then + return 0 + else + return 1 + fi +} +################################################################################ ############################### MAIN ########################################### ################################################################################ From 030c23766fcfbbe1ae4b4f4d08aa5f665be9e036 Mon Sep 17 00:00:00 2001 From: Victor Martinez Date: Mon, 29 Jun 2020 07:48:51 +0100 Subject: [PATCH 6/9] fix: typo --- lib/linter.sh | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/linter.sh b/lib/linter.sh index a48f8bbe..ac5929dc 100755 --- a/lib/linter.sh +++ b/lib/linter.sh @@ -563,7 +563,7 @@ LintAnsibleFiles() # Store the linting as a temporary file in TAP format # ####################################################### if IsTAP ; then - echo "nok ok ${INDEX} - ${FILE}" >> "${TMPFILE}" + echo "not ok ${INDEX} - ${FILE}" >> "${TMPFILE}" printf " ---\n message:[%s]\n ..." "$LINT_CMD" >> "${TMPFILE}" fi else @@ -1912,7 +1912,7 @@ LintCodebase() # Store the linting as a temporary file in TAP format # ####################################################### if IsTAP ; then - echo "nok ok ${INDEX} - ${FILE}" >> "${TMPFILE}" + echo "not ok ${INDEX} - ${FILE}" >> "${TMPFILE}" printf " ---\n message:[%s]\n ..." "$LINT_CMD" >> "${TMPFILE}" fi From 9a909c5d1d0da0ad4ca7ceec371d10e1e90a871c Mon Sep 17 00:00:00 2001 From: Victor Martinez Date: Mon, 6 Jul 2020 18:06:58 +0100 Subject: [PATCH 7/9] Output transformation (with error messages or simpler) (#1) * Output transformation (with error messages or simpler) * colon causes issues when transforming TAP to XUnit --- Dockerfile | 3 ++- README.md | 6 ++++-- lib/linter.sh | 30 ++++++++++++++++++++++++++++-- 3 files changed, 34 insertions(+), 5 deletions(-) diff --git a/Dockerfile b/Dockerfile index ce1ee696..9b8e748b 100644 --- a/Dockerfile +++ b/Dockerfile @@ -186,7 +186,8 @@ ENV GITHUB_SHA=${GITHUB_SHA} \ ACTIONS_RUNNER_DEBUG=${ACTIONS_RUNNER_DEBUG} \ DISABLE_ERRORS=${DISABLE_ERRORS} \ OUTPUT_FORMAT=${OUTPUT_FORMAT} \ - OUTPUT_FOLDER=${OUTPUT_FOLDER} + OUTPUT_FOLDER=${OUTPUT_FOLDER} \ + OUTPUT_DETAILS=${OUTPUT_DETAILS} ############################# # Copy scripts to container # diff --git a/README.md b/README.md index 6f790344..ad1a1961 100644 --- a/README.md +++ b/README.md @@ -171,8 +171,10 @@ and won't run anything unexpected. | **ACTIONS_RUNNER_DEBUG** | `false` | Flag to enable additional information about the linter, versions, and additional output. | | **DISABLE_ERRORS** | `false` | Flag to have the linter complete with exit code 0 even if errors were detected. | | **DEFAULT_WORKSPACE** | `/tmp/lint` | The location containing files to lint if you are running locally. | -| **OUTPUT_FORMAT** | `` | The report format to be generated, besides the stdout one. Supported formats: tap | -| **OUTPUT_FOLDER** | `super-linter.report` | The location where the output reporting will be generated to. | +| **OUTPUT_FORMAT** | `` | The report format to be generated, besides the stdout one. Supported formats: tap | +| **OUTPUT_FOLDER** | `super-linter.report` | The location where the output reporting will be generated to. | +| **OUTPUT_DETAILS** | `simpler` | What level of details to be reported. Supported formats: simpler or detailed. | + ### Template rules files You can use the **GitHub** **Super-Linter** *with* or *without* your own personal rules sets. This allows for greater flexibility for each individual code base. The Template rules all try to follow the standards we believe should be enabled at the basic level. diff --git a/lib/linter.sh b/lib/linter.sh index 87cdffeb..d5576f9c 100755 --- a/lib/linter.sh +++ b/lib/linter.sh @@ -139,6 +139,7 @@ DEFAULT_IFS="$IFS" # Get the Default IFS for updating ############## OUTPUT_FORMAT="${OUTPUT_FORMAT}" # Output format to be generated. Default none OUTPUT_FOLDER="${OUTPUT_FOLDER:-super-linter.report}" # Folder where the reports are generated. Default super-linter.report +OUTPUT_DETAILS="${OUTPUT_DETAILS:-simpler}" # What level of details. (simpler or detailed). Default simpler REPORT_OUTPUT_FOLDER="${DEFAULT_WORKSPACE}/${OUTPUT_FOLDER}" ########################## @@ -577,7 +578,13 @@ LintAnsibleFiles() ####################################################### if IsTAP ; then echo "not ok ${INDEX} - ${FILE}" >> "${TMPFILE}" - printf " ---\n message:[%s]\n ..." "$LINT_CMD" >> "${TMPFILE}" + ########################################## + # Report the detailed message if enabled # + ########################################## + DETAILED_MSG=$(TransformTAPDetails "$LINT_CMD") + if [ -n "${DETAILED_MSG}" ] ; then + printf " ---\n message: %s\n ..." "$DETAILED_MSG" >> "${TMPFILE}" + fi fi else ########### @@ -2034,7 +2041,13 @@ LintCodebase() ####################################################### if IsTAP ; then echo "not ok ${INDEX} - ${FILE}" >> "${TMPFILE}" - printf " ---\n message:[%s]\n ..." "$LINT_CMD" >> "${TMPFILE}" + ########################################## + # Report the detailed message if enabled # + ########################################## + DETAILED_MSG=$(TransformTAPDetails "$LINT_CMD") + if [ -n "${DETAILED_MSG}" ] ; then + printf " ---\n message: %s\n ..." "$DETAILED_MSG" >> "${TMPFILE}" + fi fi else @@ -2430,6 +2443,19 @@ IsTAP() return 1 fi } +################################################################################ +#### Function TransformTAPDetails ############################################## +TransformTAPDetails() +{ + DATA=$1 + if [ -n "${DATA}" ] && [ "${OUTPUT_DETAILS}" == "detailed" ] ; then + ######################################################### + # Transform new lines to \\n, remove colours and colons # + ######################################################### + echo "${DATA}" | awk 'BEGIN{RS="\n";ORS="\\n"}1' | sed -r "s/\x1B\[([0-9]{1,3}(;[0-9]{1,2})?)?[mGK]//g" | tr ':' ' ' + fi +} + ################################################################################ ############################### MAIN ########################################### ################################################################################ From 0e9439d9a0b64e85d141a31bb8d5f15ba3832bc3 Mon Sep 17 00:00:00 2001 From: Victor Martinez Date: Tue, 14 Jul 2020 08:50:31 +0100 Subject: [PATCH 8/9] Apply suggestions from code review Co-authored-by: Zack Koppert --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 038b7268..9ef3b20c 100644 --- a/README.md +++ b/README.md @@ -189,8 +189,8 @@ and won't run anything unexpected. | **ACTIONS_RUNNER_DEBUG** | `false` | Flag to enable additional information about the linter, versions, and additional output. | | **DISABLE_ERRORS** | `false` | Flag to have the linter complete with exit code 0 even if errors were detected. | | **DEFAULT_WORKSPACE** | `/tmp/lint` | The location containing files to lint if you are running locally. | -| **OUTPUT_FORMAT** | `` | The report format to be generated, besides the stdout one. Supported formats: tap | -| **OUTPUT_FOLDER** | `super-linter.report` | The location where the output reporting will be generated to. | +| **OUTPUT_FORMAT** | `` | The report format to be generated, besides the stdout one. Output format of tap is currently using v13 of the specification. Supported formats: tap | +| **OUTPUT_FOLDER** | `super-linter.report` | The location where the output reporting will be generated to. Output folder must not previously exist. | | **OUTPUT_DETAILS** | `simpler` | What level of details to be reported. Supported formats: simpler or detailed. | From fdfa61e6a0fbd19dcd2f4a0161528a0d6c3cd925 Mon Sep 17 00:00:00 2001 From: Victor Martinez Date: Tue, 14 Jul 2020 08:51:53 +0100 Subject: [PATCH 9/9] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9ef3b20c..266d2580 100644 --- a/README.md +++ b/README.md @@ -189,7 +189,7 @@ and won't run anything unexpected. | **ACTIONS_RUNNER_DEBUG** | `false` | Flag to enable additional information about the linter, versions, and additional output. | | **DISABLE_ERRORS** | `false` | Flag to have the linter complete with exit code 0 even if errors were detected. | | **DEFAULT_WORKSPACE** | `/tmp/lint` | The location containing files to lint if you are running locally. | -| **OUTPUT_FORMAT** | `` | The report format to be generated, besides the stdout one. Output format of tap is currently using v13 of the specification. Supported formats: tap | +| **OUTPUT_FORMAT** | `none` | The report format to be generated, besides the stdout one. Output format of tap is currently using v13 of the specification. Supported formats: tap | | **OUTPUT_FOLDER** | `super-linter.report` | The location where the output reporting will be generated to. Output folder must not previously exist. | | **OUTPUT_DETAILS** | `simpler` | What level of details to be reported. Supported formats: simpler or detailed. |