actions/superlint
1
0
Fork 0
mirror of https://github.com/super-linter/super-linter.git synced 2024-11-24 01:31:01 -05:00
Code Issues Projects Releases Packages Wiki Activity
superlint/lib/linter.sh

900 lines
36 KiB
Bash
Raw Normal View History

Use portable shebang
2020-06-23 12:02:45 -04:00
#!/usr/bin/env bash
initial commit
2019-10-21 10:12:50 -04:00
Remove unneeded variables and eval the rest
2020-09-28 16:29:48 -04:00
##################################################################
# Debug Vars #
# Define these early, so we can use debug logging ASAP if needed #
##################################################################
feat: validate variables and simplify lowercase (#5128) - Validate variables representing boolean values. - Group global variables in the same sections. - Declare variables as lowercase with the 'declare -l' shell builtin for more clarity.
2024-01-11 15:30:00 -05:00
declare -l ACTIONS_RUNNER_DEBUG
ACTIONS_RUNNER_DEBUG="${ACTIONS_RUNNER_DEBUG:-"false"}" # Boolean to see even more info (debug)
IMAGE="${IMAGE:-standard}" # Version of the Super-linter (standard,slim,etc)
Remove unneeded variables and eval the rest
2020-09-28 16:29:48 -04:00
##################################################################
# Log Vars #
# Define these early, so we can use debug logging ASAP if needed #
##################################################################
Don't write colors and logs on disk if not necessary (#4934) * Don't write colors and logs on disk if not necessary * Set color markers * Fix colors * Fix linting errors * Fix linting errors * Use sudo to access logs
2023-12-05 03:04:13 -05:00
LOG_FILE="${LOG_FILE:-"super-linter.log"}" # Default log file name (located in GITHUB_WORKSPACE folder)
fix: unset the log_level variable (#5249) - Super-linter uses the LOG_LEVEL variable to let the user configure the desired log level. Checkov and Renovate use a variable with the same name for the same purpose, but accept a different set of values, and exit with an error if it gets an unknown value for that variable. - Refactor the VERBOSE log level to the more commonly used INFO. Configuration validation will warn users if they use VERBOSE and instruct them to use INFO instead. This is not a breaking change because super-linter falls back on INFO if VERBOSE is set. - Remove the TRACE log level because we rarely used it. As with VERBOSE, configuration validation will warn the user. Fall back to DEBUG if the user configured LOG_LEVEL to VERBOSE. Close #5217
2024-02-09 13:43:58 -05:00
LOG_LEVEL="${LOG_LEVEL:-"INFO"}"
feat: validate variables and simplify lowercase (#5128) - Validate variables representing boolean values. - Group global variables in the same sections. - Declare variables as lowercase with the 'declare -l' shell builtin for more clarity.
2024-01-11 15:30:00 -05:00
declare -l CREATE_LOG_FILE
Conditionally create log file
2023-01-05 08:32:46 -05:00
CREATE_LOG_FILE="${CREATE_LOG_FILE:-"false"}"
Initialize all log-related ASAP
2020-09-29 16:46:24 -04:00
Remove unneeded variables and eval the rest
2020-09-28 16:29:48 -04:00
if [[ ${ACTIONS_RUNNER_DEBUG} == true ]]; then LOG_LEVEL="DEBUG"; fi
# Boolean to see debug logs
LOG_DEBUG=$(if [[ ${LOG_LEVEL} == "DEBUG" || ${LOG_LEVEL} == "TRACE" ]]; then echo "true"; fi)
export LOG_DEBUG
fix: unset the log_level variable (#5249) - Super-linter uses the LOG_LEVEL variable to let the user configure the desired log level. Checkov and Renovate use a variable with the same name for the same purpose, but accept a different set of values, and exit with an error if it gets an unknown value for that variable. - Refactor the VERBOSE log level to the more commonly used INFO. Configuration validation will warn users if they use VERBOSE and instruct them to use INFO instead. This is not a breaking change because super-linter falls back on INFO if VERBOSE is set. - Remove the TRACE log level because we rarely used it. As with VERBOSE, configuration validation will warn the user. Fall back to DEBUG if the user configured LOG_LEVEL to VERBOSE. Close #5217
2024-02-09 13:43:58 -05:00
# Boolean to see info logs
LOG_VERBOSE=$(if [[ ${LOG_LEVEL} == "INFO" || ${LOG_LEVEL} == "VERBOSE" || ${LOG_LEVEL} == "DEBUG" || ${LOG_LEVEL} == "TRACE" ]]; then echo "true"; fi)
Remove unneeded variables and eval the rest
2020-09-28 16:29:48 -04:00
export LOG_VERBOSE
Add notice warn and error log levels
2020-10-28 20:08:01 -04:00
# Boolean to see notice logs
fix: unset the log_level variable (#5249) - Super-linter uses the LOG_LEVEL variable to let the user configure the desired log level. Checkov and Renovate use a variable with the same name for the same purpose, but accept a different set of values, and exit with an error if it gets an unknown value for that variable. - Refactor the VERBOSE log level to the more commonly used INFO. Configuration validation will warn users if they use VERBOSE and instruct them to use INFO instead. This is not a breaking change because super-linter falls back on INFO if VERBOSE is set. - Remove the TRACE log level because we rarely used it. As with VERBOSE, configuration validation will warn the user. Fall back to DEBUG if the user configured LOG_LEVEL to VERBOSE. Close #5217
2024-02-09 13:43:58 -05:00
LOG_NOTICE=$(if [[ ${LOG_LEVEL} == "NOTICE" || ${LOG_LEVEL} == "INFO" || ${LOG_LEVEL} == "VERBOSE" || ${LOG_LEVEL} == "DEBUG" || ${LOG_LEVEL} == "TRACE" ]]; then echo "true"; fi)
Add notice warn and error log levels
2020-10-28 20:08:01 -04:00
export LOG_NOTICE
# Boolean to see warn logs
fix: unset the log_level variable (#5249) - Super-linter uses the LOG_LEVEL variable to let the user configure the desired log level. Checkov and Renovate use a variable with the same name for the same purpose, but accept a different set of values, and exit with an error if it gets an unknown value for that variable. - Refactor the VERBOSE log level to the more commonly used INFO. Configuration validation will warn users if they use VERBOSE and instruct them to use INFO instead. This is not a breaking change because super-linter falls back on INFO if VERBOSE is set. - Remove the TRACE log level because we rarely used it. As with VERBOSE, configuration validation will warn the user. Fall back to DEBUG if the user configured LOG_LEVEL to VERBOSE. Close #5217
2024-02-09 13:43:58 -05:00
LOG_WARN=$(if [[ ${LOG_LEVEL} == "WARN" || ${LOG_LEVEL} == "NOTICE" || ${LOG_LEVEL} == "INFO" || ${LOG_LEVEL} == "VERBOSE" || ${LOG_LEVEL} == "DEBUG" || ${LOG_LEVEL} == "TRACE" ]]; then echo "true"; fi)
Add notice warn and error log levels
2020-10-28 20:08:01 -04:00
export LOG_WARN
# Boolean to see error logs
fix: unset the log_level variable (#5249) - Super-linter uses the LOG_LEVEL variable to let the user configure the desired log level. Checkov and Renovate use a variable with the same name for the same purpose, but accept a different set of values, and exit with an error if it gets an unknown value for that variable. - Refactor the VERBOSE log level to the more commonly used INFO. Configuration validation will warn users if they use VERBOSE and instruct them to use INFO instead. This is not a breaking change because super-linter falls back on INFO if VERBOSE is set. - Remove the TRACE log level because we rarely used it. As with VERBOSE, configuration validation will warn the user. Fall back to DEBUG if the user configured LOG_LEVEL to VERBOSE. Close #5217
2024-02-09 13:43:58 -05:00
LOG_ERROR=$(if [[ ${LOG_LEVEL} == "ERROR" || ${LOG_LEVEL} == "WARN" || ${LOG_LEVEL} == "NOTICE" || ${LOG_LEVEL} == "INFO" || ${LOG_LEVEL} == "VERBOSE" || ${LOG_LEVEL} == "DEBUG" || ${LOG_LEVEL} == "TRACE" ]]; then echo "true"; fi)
Add notice warn and error log levels
2020-10-28 20:08:01 -04:00
export LOG_ERROR
Remove unneeded variables and eval the rest
2020-09-28 16:29:48 -04:00
fix: unset the log_level variable (#5249) - Super-linter uses the LOG_LEVEL variable to let the user configure the desired log level. Checkov and Renovate use a variable with the same name for the same purpose, but accept a different set of values, and exit with an error if it gets an unknown value for that variable. - Refactor the VERBOSE log level to the more commonly used INFO. Configuration validation will warn users if they use VERBOSE and instruct them to use INFO instead. This is not a breaking change because super-linter falls back on INFO if VERBOSE is set. - Remove the TRACE log level because we rarely used it. As with VERBOSE, configuration validation will warn the user. Fall back to DEBUG if the user configured LOG_LEVEL to VERBOSE. Close #5217
2024-02-09 13:43:58 -05:00
unset LOG_LEVEL
creating files
2020-06-29 10:55:59 -04:00
#########################
# Source Function Files #
#########################
Fix new issues
2020-06-30 10:56:15 -04:00
# shellcheck source=/dev/null
break out: (#990) * break out: * fix it * fix source * add them exports * more path * more path
2020-11-12 12:27:34 -05:00
source /action/lib/functions/buildFileList.sh # Source the function script(s)
Fix new issues
2020-06-30 10:56:15 -04:00
# shellcheck source=/dev/null
Certs (#1470) * adding cert * update readme * typo * make exec * spaces * adding better way * adding example * make shell happy * fix space * adding notes * bad var * duh
2021-04-26 10:00:42 -04:00
source /action/lib/functions/detectFiles.sh # Source the function script(s)
Fix new issues
2020-06-30 10:56:15 -04:00
# shellcheck source=/dev/null
Certs (#1470) * adding cert * update readme * typo * make exec * spaces * adding better way * adding example * make shell happy * fix space * adding notes * bad var * duh
2021-04-26 10:00:42 -04:00
source /action/lib/functions/linterRules.sh # Source the function script(s)
# shellcheck source=/dev/null
source /action/lib/functions/log.sh # Source the function script(s)
break out: (#990) * break out: * fix it * fix source * add them exports * more path * more path
2020-11-12 12:27:34 -05:00
# shellcheck source=/dev/null
Certs (#1470) * adding cert * update readme * typo * make exec * spaces * adding better way * adding example * make shell happy * fix space * adding notes * bad var * duh
2021-04-26 10:00:42 -04:00
source /action/lib/functions/updateSSL.sh # Source the function script(s)
break out: (#990) * break out: * fix it * fix source * add them exports * more path * more path
2020-11-12 12:27:34 -05:00
# shellcheck source=/dev/null
Certs (#1470) * adding cert * update readme * typo * make exec * spaces * adding better way * adding example * make shell happy * fix space * adding notes * bad var * duh
2021-04-26 10:00:42 -04:00
source /action/lib/functions/validation.sh # Source the function script(s)
break out: (#990) * break out: * fix it * fix source * add them exports * more path * more path
2020-11-12 12:27:34 -05:00
# shellcheck source=/dev/null
Certs (#1470) * adding cert * update readme * typo * make exec * spaces * adding better way * adding example * make shell happy * fix space * adding notes * bad var * duh
2021-04-26 10:00:42 -04:00
source /action/lib/functions/worker.sh # Source the function script(s)
feat: add SSH key support (#2454) * feat: add support for ssh keys and github.com connections * refactor: allow github.com setup and update docs * docs: add note about using ssh_key * fix: run shfmt * fix: add language to ssh key fence * fix: make ssh setup script executable * fix: gitleaks wins, openssh example removed * notes * docs: make the docs a little more clear Co-authored-by: Admiral Awkbar <admiralawkbar@github.com>
2022-02-09 16:24:57 -05:00
# shellcheck source=/dev/null
source /action/lib/functions/setupSSH.sh # Source the function script(s)
fix: fix GITHUB_BEFORE_SHA initalization for push (#5098)
2024-01-05 17:07:39 -05:00
# shellcheck source=/dev/null
source /action/lib/functions/githubEvent.sh
creating files
2020-06-29 10:55:59 -04:00
feat: validate variables and simplify lowercase (#5128) - Validate variables representing boolean values. - Group global variables in the same sections. - Declare variables as lowercase with the 'declare -l' shell builtin for more clarity.
2024-01-11 15:30:00 -05:00
# We want a lowercase value
declare -l RUN_LOCAL
Group log output on GitHub Actions (#4961)
2023-12-12 14:57:15 -05:00
# Initialize RUN_LOCAL early because we need it for logging
feat: validate variables and simplify lowercase (#5128) - Validate variables representing boolean values. - Group global variables in the same sections. - Declare variables as lowercase with the 'declare -l' shell builtin for more clarity.
2024-01-11 15:30:00 -05:00
RUN_LOCAL="${RUN_LOCAL:-"false"}"
Group log output on GitHub Actions (#4961)
2023-12-12 14:57:15 -05:00
# Dynamically set the default behavior for GitHub Actions log markers because
# we want to give users a chance to enable this even when running locally, but
# we still want to provide a default value in case they don't want to explictly
# configure it.
if [[ "${RUN_LOCAL}" == "true" ]]; then
DEFAULT_ENABLE_GITHUB_ACTIONS_GROUP_TITLE="false"
else
DEFAULT_ENABLE_GITHUB_ACTIONS_GROUP_TITLE="true"
fi
# Let users configure GitHub Actions log markers regardless of running locally or not
ENABLE_GITHUB_ACTIONS_GROUP_TITLE="${ENABLE_GITHUB_ACTIONS_GROUP_TITLE:-"${DEFAULT_ENABLE_GITHUB_ACTIONS_GROUP_TITLE}"}"
feat: run linters in parallel (#5177)
2024-01-30 14:24:55 -05:00
export ENABLE_GITHUB_ACTIONS_GROUP_TITLE
Group log output on GitHub Actions (#4961)
2023-12-12 14:57:15 -05:00
startGitHubActionsLogGroup "${SUPER_LINTER_INITIALIZATION_LOG_GROUP_TITLE}"
feat: validate variables and simplify lowercase (#5128) - Validate variables representing boolean values. - Group global variables in the same sections. - Declare variables as lowercase with the 'declare -l' shell builtin for more clarity.
2024-01-11 15:30:00 -05:00
# We want a lowercase value
declare -l DISABLE_ERRORS
DISABLE_ERRORS="${DISABLE_ERRORS:-"false"}"
# We want a lowercase value
declare -l IGNORE_GENERATED_FILES
# Do not ignore generated files by default for backwards compatibility
IGNORE_GENERATED_FILES="${IGNORE_GENERATED_FILES:-false}"
feat: run linters in parallel (#5177)
2024-01-30 14:24:55 -05:00
export IGNORE_GENERATED_FILES
feat: validate variables and simplify lowercase (#5128) - Validate variables representing boolean values. - Group global variables in the same sections. - Declare variables as lowercase with the 'declare -l' shell builtin for more clarity.
2024-01-11 15:30:00 -05:00
# We want a lowercase value
declare -l IGNORE_GITIGNORED_FILES
IGNORE_GITIGNORED_FILES="${IGNORE_GITIGNORED_FILES:-false}"
feat: run linters in parallel (#5177)
2024-01-30 14:24:55 -05:00
export IGNORE_GITIGNORED_FILES
feat: validate variables and simplify lowercase (#5128) - Validate variables representing boolean values. - Group global variables in the same sections. - Declare variables as lowercase with the 'declare -l' shell builtin for more clarity.
2024-01-11 15:30:00 -05:00
# We want a lowercase value
declare -l MULTI_STATUS
MULTI_STATUS="${MULTI_STATUS:-true}"
# We want a lowercase value
declare -l SSH_INSECURE_NO_VERIFY_GITHUB_KEY
SSH_INSECURE_NO_VERIFY_GITHUB_KEY="${SSH_INSECURE_NO_VERIFY_GITHUB_KEY:-false}"
# We want a lowercase value
declare -l SSH_SETUP_GITHUB
SSH_SETUP_GITHUB="${SSH_SETUP_GITHUB:-false}"
# We want a lowercase value
declare -l SUPPRESS_FILE_TYPE_WARN
SUPPRESS_FILE_TYPE_WARN="${SUPPRESS_FILE_TYPE_WARN:-false}"
# We want a lowercase value
declare -l SUPPRESS_POSSUM
SUPPRESS_POSSUM="${SUPPRESS_POSSUM:-false}"
# We want a lowercase value
declare -l TEST_CASE_RUN
# Option to tell code to run only test cases
TEST_CASE_RUN="${TEST_CASE_RUN:-"false"}"
# We want a lowercase value
declare -l USE_FIND_ALGORITHM
USE_FIND_ALGORITHM="${USE_FIND_ALGORITHM:-false}"
# We want a lowercase value
declare -l VALIDATE_ALL_CODEBASE
VALIDATE_ALL_CODEBASE="${VALIDATE_ALL_CODEBASE:-"true"}"
# We want a lowercase value
declare -l YAML_ERROR_ON_WARNING
YAML_ERROR_ON_WARNING="${YAML_ERROR_ON_WARNING:-false}"
ValidateBooleanConfigurationVariables
Group log output on GitHub Actions (#4961)
2023-12-12 14:57:15 -05:00
initial commit
2019-10-21 10:12:50 -04:00
###########
adding it
2019-10-21 12:05:55 -04:00
# GLOBALS #
initial commit
2019-10-21 10:12:50 -04:00
###########
feat: validate variables and simplify lowercase (#5128) - Validate variables representing boolean values. - Group global variables in the same sections. - Declare variables as lowercase with the 'declare -l' shell builtin for more clarity.
2024-01-11 15:30:00 -05:00
DEFAULT_RULES_LOCATION='/action/lib/.automation' # Default rules files location
DEFAULT_SUPER_LINTER_WORKSPACE="/tmp/lint" # Fall-back value for the workspace
DEFAULT_WORKSPACE="${DEFAULT_WORKSPACE:-${DEFAULT_SUPER_LINTER_WORKSPACE}}" # Default workspace if running locally
FILTER_REGEX_INCLUDE="${FILTER_REGEX_INCLUDE:-""}"
FILTER_REGEX_EXCLUDE="${FILTER_REGEX_EXCLUDE:-""}"
fix: initialize GitHub domain variable (#5216) - Initialize GITHUB_DOMAIN as documented in the README - Configure other URLs according to GITHUB_DOMAIN - Automatically fetch SSH key fingerprints for GITHUB_DOMAINS
2024-02-09 13:45:44 -05:00
GITHUB_DOMAIN="${GITHUB_DOMAIN:-"github.com"}"
GITHUB_DOMAIN="${GITHUB_DOMAIN%/}" # Remove trailing slash if present
Improve GITHUB_API_URL default value handling (#2031) * Improve GITHUB_API_URL default value handling GitHub Actions [already has](https://docs.github.com/en/actions/learn-github-actions/environment-variables#default-environment-variables) `GITHUB_API_URL` environment variable which contains GitHub API URL. We should be smart about overriding it and, if it exist and already has value, we should not override it. * Strip slash from GITHUB_API_URL * Update linter.sh * Update linter.sh * make shfmt happy Co-authored-by: Lukas Gravley <admiralawkbar@github.com>
2021-10-04 10:53:43 -04:00
# GitHub API root url
fix: initialize GitHub domain variable (#5216) - Initialize GITHUB_DOMAIN as documented in the README - Configure other URLs according to GITHUB_DOMAIN - Automatically fetch SSH key fingerprints for GITHUB_DOMAINS
2024-02-09 13:45:44 -05:00
GITHUB_API_URL="${GITHUB_CUSTOM_API_URL:-"https://api.${GITHUB_DOMAIN}"}"
GITHUB_API_URL="${GITHUB_API_URL%/}" # Remove trailing slash if present
GITHUB_SERVER_URL="https://${GITHUB_DOMAIN}"
# shellcheck disable=SC2034 # Variable is referenced indirectly
GITHUB_META_URL="${GITHUB_API_URL}/meta"
Improve GITHUB_API_URL default value handling (#2031) * Improve GITHUB_API_URL default value handling GitHub Actions [already has](https://docs.github.com/en/actions/learn-github-actions/environment-variables#default-environment-variables) `GITHUB_API_URL` environment variable which contains GitHub API URL. We should be smart about overriding it and, if it exist and already has value, we should not override it. * Strip slash from GITHUB_API_URL * Update linter.sh * Update linter.sh * make shfmt happy Co-authored-by: Lukas Gravley <admiralawkbar@github.com>
2021-10-04 10:53:43 -04:00
LINTER_RULES_PATH="${LINTER_RULES_PATH:-.github/linters}" # Linter rules directory
feat: validate variables and simplify lowercase (#5128) - Validate variables representing boolean values. - Group global variables in the same sections. - Declare variables as lowercase with the 'declare -l' shell builtin for more clarity.
2024-01-11 15:30:00 -05:00
# shellcheck disable=SC2034 # Variable is referenced in other scripts
RAW_FILE_ARRAY=() # Array of all files that were changed
# shellcheck disable=SC2034 # Variable is referenced in other scripts
TEST_CASE_FOLDER='test/linters' # Folder for test cases we should always ignore
Don't write colors and logs on disk if not necessary (#4934) * Don't write colors and logs on disk if not necessary * Set color markers * Fix colors * Fix linting errors * Fix linting errors * Use sudo to access logs
2023-12-05 03:04:13 -05:00
Switch to tflint image because tflint-bundle is deprecated (#4990) * Switch to tflint image because tflint-bundle is deprecated * Fix version string * Don't copy plugins * Don't copy plugins * Set terraform log vars globally * Fix tflint error
2023-12-15 04:29:34 -05:00
# Set the log level
TF_LOG_LEVEL="info"
if [ "${ACTIONS_RUNNER_DEBUG}" = "true" ]; then
TF_LOG_LEVEL="debug"
fi
export TF_LOG_LEVEL
debug "TF_LOG_LEVEL: ${TF_LOG_LEVEL}"
TFLINT_LOG="${TF_LOG_LEVEL}"
export TFLINT_LOG
debug "TFLINT_LOG: ${TFLINT_LOG}"
Simplify rules files loading, plus fixes
2020-10-15 05:43:56 -04:00
###############
# Rules files #
###############
# shellcheck disable=SC2034 # Variable is referenced indirectly
Add new ENV VAR to set ansible-lint config file (#1424)
2021-04-11 23:24:43 -04:00
ANSIBLE_FILE_NAME="${ANSIBLE_CONFIG_FILE:-.ansible-lint.yml}"
Simplify rules files loading, plus fixes
2020-10-15 05:43:56 -04:00
# shellcheck disable=SC2034 # Variable is referenced indirectly
ARM_FILE_NAME=".arm-ttk.psd1"
feat: add support for checkov to lint iac files (#4925) - Add support to run Checkov against infrastructure as code descriptors that are in a given (configurable) directory. Defaults to lint the whole workspace. - Establish a baseline for our own codebase so we don't have to fix issues right away with this change.
2023-12-22 07:22:15 -05:00
CHECKOV_FILE_NAME="${CHECKOV_FILE_NAME:-".checkov.yaml"}"
Simplify rules files loading, plus fixes
2020-10-15 05:43:56 -04:00
# shellcheck disable=SC2034 # Variable is referenced indirectly
CLOJURE_FILE_NAME=".clj-kondo/config.edn"
# shellcheck disable=SC2034 # Variable is referenced indirectly
CLOUDFORMATION_FILE_NAME=".cfnlintrc.yml"
# shellcheck disable=SC2034 # Variable is referenced indirectly
COFFEESCRIPT_FILE_NAME=".coffee-lint.json"
CSS_FILE_NAME="${CSS_FILE_NAME:-.stylelintrc.json}"
Don't override the secondary rules file path, if available
2020-10-30 07:15:16 -04:00
DOCKERFILE_HADOLINT_FILE_NAME="${DOCKERFILE_HADOLINT_FILE_NAME:-.hadolint.yaml}"
Simplify rules files loading, plus fixes
2020-10-15 05:43:56 -04:00
EDITORCONFIG_FILE_NAME="${EDITORCONFIG_FILE_NAME:-.ecrc}"
# shellcheck disable=SC2034 # Variable is referenced indirectly
Adding actionlint (#1775) * Adding action lint * adding tests * adding tests * Update Dockerfile Co-authored-by: Masaya Suzuki <15100604+massongit@users.noreply.github.com> * cleanup name * fix test * typo * fix file name * fix our own errors * more cleanup * angry * make it happy * stop double jobs Co-authored-by: Masaya Suzuki <15100604+massongit@users.noreply.github.com>
2021-07-19 10:28:49 -04:00
GITHUB_ACTIONS_FILE_NAME="${GITHUB_ACTIONS_CONFIG_FILE:-actionlint.yml}"
# shellcheck disable=SC2034 # Variable is referenced indirectly
Add GITHUB_ACTIONS_COMMAND_ARGS environment variable Signed-off-by: Brett Logan <lindluni@github.com>
2023-01-04 00:05:31 -05:00
GITHUB_ACTIONS_COMMAND_ARGS="${GITHUB_ACTIONS_COMMAND_ARGS:-null}"
# shellcheck disable=SC2034 # Variable is referenced indirectly
Bump snakemake from 6.8.0 to 6.8.1 in /dependencies (#2004) * Bump snakemake from 6.8.0 to 6.8.1 in /dependencies Bumps [snakemake](https://github.com/snakemake/snakemake) from 6.8.0 to 6.8.1. - [Release notes](https://github.com/snakemake/snakemake/releases) - [Commits](https://github.com/snakemake/snakemake/compare/v6.8.0...v6.8.1) --- updated-dependencies: - dependency-name: snakemake dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> * fixed dead var * typo in name Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Lukas Gravley <admiralawkbar@github.com>
2021-09-27 12:02:18 -04:00
GITLEAKS_FILE_NAME="${GITLEAKS_CONFIG_FILE:-.gitleaks.toml}"
Add Gitleaks for secret scanning (#1951) * Add actionlint * adding gitleaks * rm secretlint * Update .gitleaks.toml Co-authored-by: Admiral Awkbar <admiralawkbar@github.com>
2021-09-27 10:32:18 -04:00
# shellcheck disable=SC2034 # Variable is referenced indirectly
Gherkin (#1011) * adding gherkin * adding to array * fix space * Update Dockerfile * adding rules * adding rules Co-authored-by: SVN Migrator <someone@somewhere.com>
2020-11-19 10:54:20 -05:00
GHERKIN_FILE_NAME=".gherkin-lintrc"
# shellcheck disable=SC2034 # Variable is referenced indirectly
Simplify rules files loading, plus fixes
2020-10-15 05:43:56 -04:00
GO_FILE_NAME=".golangci.yml"
# shellcheck disable=SC2034 # Variable is referenced indirectly
GROOVY_FILE_NAME=".groovylintrc.json"
# shellcheck disable=SC2034 # Variable is referenced indirectly
HTML_FILE_NAME=".htmlhintrc"
# shellcheck disable=SC2034 # Variable is referenced indirectly
Added support for changing Checkstyle rules file name (#1760) Resolves https://github.com/github/super-linter/issues/680
2021-07-14 10:45:07 -04:00
JAVA_FILE_NAME="${JAVA_FILE_NAME:-sun_checks.xml}"
Simplify rules files loading, plus fixes
2020-10-15 05:43:56 -04:00
# shellcheck disable=SC2034 # Variable is referenced indirectly
JAVASCRIPT_ES_FILE_NAME="${JAVASCRIPT_ES_CONFIG_FILE:-.eslintrc.yml}"
# shellcheck disable=SC2034 # Variable is referenced indirectly
Adding support for Prettier (#1118) * adding it * fix spaces * vars were backwards * remove prettier from function test
2021-01-04 12:07:57 -05:00
JAVASCRIPT_DEFAULT_STYLE="${JAVASCRIPT_DEFAULT_STYLE:-standard}"
JAVASCRIPT_STYLE_NAME='' # Variable for the style
# shellcheck disable=SC2034 # Variable is referenced indirectly
Simplify rules files loading, plus fixes
2020-10-15 05:43:56 -04:00
JAVASCRIPT_STANDARD_FILE_NAME="${JAVASCRIPT_ES_CONFIG_FILE:-.eslintrc.yml}"
# shellcheck disable=SC2034 # Variable is referenced indirectly
Install, configure, and run jscpd. Add missing tests (#1032) Co-authored-by: Gabo <gabo.fdc@gmail.com> Co-authored-by: Matt Desmond <beardofedu@github.com> Co-authored-by: Lukas Gravley <admiralawkbar@github.com>
2021-01-27 14:47:34 -05:00
JSCPD_FILE_NAME="${JSCPD_CONFIG_FILE:-.jscpd.json}"
# shellcheck disable=SC2034 # Variable is referenced indirectly
Simplify rules files loading, plus fixes
2020-10-15 05:43:56 -04:00
JSX_FILE_NAME="${JAVASCRIPT_ES_CONFIG_FILE:-.eslintrc.yml}"
# shellcheck disable=SC2034 # Variable is referenced indirectly
Address PR comments Signed-off-by: Brett Logan <lindluni@github.com>
2023-01-11 11:21:02 -05:00
KUBERNETES_KUBECONFORM_OPTIONS="${KUBERNETES_KUBECONFORM_OPTIONS:-null}"
Kube (#1609) * adding var * adding var * bug * spacing * better name
2021-06-01 16:04:25 -04:00
# shellcheck disable=SC2034 # Variable is referenced indirectly
Simplify rules files loading, plus fixes
2020-10-15 05:43:56 -04:00
LATEX_FILE_NAME=".chktexrc"
# shellcheck disable=SC2034 # Variable is referenced indirectly
LUA_FILE_NAME=".luacheckrc"
# shellcheck disable=SC2034 # Variable is referenced indirectly
MARKDOWN_FILE_NAME="${MARKDOWN_CONFIG_FILE:-.markdown-lint.yml}"
# shellcheck disable=SC2034 # Variable is referenced indirectly
OPENAPI_FILE_NAME=".openapirc.yml"
# shellcheck disable=SC2034 # Variable is referenced indirectly
Add Perl::Critic::Community and PERL_PERLCRITIC_OPTIONS to allow passing command line options to perlcritic (#2684) Co-authored-by: Stephen Abbene <sabbene@users.noreply.github.com>
2022-03-28 09:56:50 -04:00
PERL_PERLCRITIC_OPTIONS="${PERL_PERLCRITIC_OPTIONS:-null}"
# shellcheck disable=SC2034 # Variable is referenced indirectly
adding rules file (#1644) * adding rules file * fix naming * cleanup * make smart * fixing the make * adding template * white space * not sure how i got windows * found the space
2021-06-09 12:53:11 -04:00
PHP_BUILTIN_FILE_NAME="${PHP_CONFIG_FILE:-php.ini}"
# shellcheck disable=SC2034 # Variable is referenced indirectly
Allow to overwrite `PHP_PHPCS_FILE_NAME` value (#4849) * Allow to overwrite PHP_PHPCS_FILE_NAME value * Update README.md
2023-11-15 01:10:36 -05:00
PHP_PHPCS_FILE_NAME="${PHP_PHPCS_FILE_NAME:-phpcs.xml}"
Simplify rules files loading, plus fixes
2020-10-15 05:43:56 -04:00
# shellcheck disable=SC2034 # Variable is referenced indirectly
PHP_PHPSTAN_FILE_NAME="phpstan.neon"
# shellcheck disable=SC2034 # Variable is referenced indirectly
PHP_PSALM_FILE_NAME="psalm.xml"
# shellcheck disable=SC2034 # Variable is referenced indirectly
Revert psd1 extension change and ignore PSMissingModuleManifestField Signed-off-by: Brett Logan <lindluni@github.com>
2022-12-23 21:01:24 -05:00
POWERSHELL_FILE_NAME=".powershell-psscriptanalyzer.psd1"
Simplify rules files loading, plus fixes
2020-10-15 05:43:56 -04:00
# shellcheck disable=SC2034 # Variable is referenced indirectly
add protolint config (#2252)
2022-01-03 12:30:56 -05:00
PROTOBUF_FILE_NAME="${PROTOBUF_CONFIG_FILE:-.protolintrc.yml}"
Simplify rules files loading, plus fixes
2020-10-15 05:43:56 -04:00
# shellcheck disable=SC2034 # Variable is referenced indirectly
PYTHON_BLACK_FILE_NAME="${PYTHON_BLACK_CONFIG_FILE:-.python-black}"
# shellcheck disable=SC2034 # Variable is referenced indirectly
PYTHON_FLAKE8_FILE_NAME="${PYTHON_FLAKE8_CONFIG_FILE:-.flake8}"
# shellcheck disable=SC2034 # Variable is referenced indirectly
adding tests
2020-10-28 11:22:55 -04:00
PYTHON_ISORT_FILE_NAME="${PYTHON_ISORT_CONFIG_FILE:-.isort.cfg}"
# shellcheck disable=SC2034 # Variable is referenced indirectly
adding Python MyPy (#1401) * adding fun * fix whitespace * adding tests * adding the array * bug in file name * fix tap * makes no sense * adding the hammer * adding some extra protbuf
2021-03-24 15:00:23 -04:00
PYTHON_MYPY_FILE_NAME="${PYTHON_MYPY_CONFIG_FILE:-.mypy.ini}"
# shellcheck disable=SC2034 # Variable is referenced indirectly
Simplify rules files loading, plus fixes
2020-10-15 05:43:56 -04:00
PYTHON_PYLINT_FILE_NAME="${PYTHON_PYLINT_CONFIG_FILE:-.python-lint}"
# shellcheck disable=SC2034 # Variable is referenced indirectly
R_FILE_NAME=".lintr"
# shellcheck disable=SC2034 # Variable is referenced indirectly
RUBY_FILE_NAME="${RUBY_CONFIG_FILE:-.ruby-lint.yml}"
# shellcheck disable=SC2034 # Variable is referenced indirectly
Adding scalafmt (#2053) * Adding scalafmt * add it Co-authored-by: Jake Herbst <jherbst@rsglab.com> Co-authored-by: Lukas Gravley <admiralawkbar@github.com>
2021-11-10 13:28:50 -05:00
SCALAFMT_FILE_NAME="${SCALAFMT_CONFIG_FILE:-.scalafmt.conf}"
# shellcheck disable=SC2034 # Variable is referenced indirectly
Simplify rules files loading, plus fixes
2020-10-15 05:43:56 -04:00
SNAKEMAKE_SNAKEFMT_FILE_NAME="${SNAKEMAKE_SNAKEFMT_CONFIG_FILE:-.snakefmt.toml}"
# shellcheck disable=SC2034 # Variable is referenced indirectly
adding it (#1396) * adding it * i kant read * make go go away
2021-03-23 13:02:16 -04:00
SQL_FILE_NAME="${SQL_CONFIG_FILE:-.sql-config.json}"
Simplify rules files loading, plus fixes
2020-10-15 05:43:56 -04:00
# shellcheck disable=SC2034 # Variable is referenced indirectly
Correct SQLFluff config filename (#2366)
2022-01-24 10:01:37 -05:00
SQLFLUFF_FILE_NAME="${SQLFLUFF_CONFIG_FILE:-/.sqlfluff}"
Allow SQLFluff configuration file to be used from standard Super Linter location (#2361)
2022-01-20 10:02:30 -05:00
# shellcheck disable=SC2034 # Variable is referenced indirectly
adding tflint (#1899) * adding tflint * fixed array * i thought this was fixed
2021-08-30 10:47:50 -04:00
TERRAFORM_TFLINT_FILE_NAME="${TERRAFORM_TFLINT_CONFIG_FILE:-.tflint.hcl}"
Simplify rules files loading, plus fixes
2020-10-15 05:43:56 -04:00
# shellcheck disable=SC2034 # Variable is referenced indirectly
Adding terrascan config file (#1761) * adding terrascan config file * fix line ending Co-authored-by: Admiral Awkbar <admiralawkbar@github.com>
2021-07-14 11:20:24 -04:00
TERRAFORM_TERRASCAN_FILE_NAME="${TERRAFORM_TERRASCAN_CONFIG_FILE:-terrascan.toml}"
# shellcheck disable=SC2034 # Variable is referenced indirectly
Add textlint (#2021) * Add textlint * Fix by textlint * Fix package-lock.json * Fix package-lock.json
2021-10-05 09:29:05 -04:00
NATURAL_LANGUAGE_FILE_NAME="${NATURAL_LANGUAGE_CONFIG_FILE:-.textlintrc}"
# shellcheck disable=SC2034 # Variable is referenced indirectly
Simplify rules files loading, plus fixes
2020-10-15 05:43:56 -04:00
TSX_FILE_NAME="${TYPESCRIPT_ES_CONFIG_FILE:-.eslintrc.yml}"
# shellcheck disable=SC2034 # Variable is referenced indirectly
Use ts-standard instead of standard as TYPESCRIPT_STANDARD (#2614) * Use ts-standard instead of standard as TYPESCRIPT_STANDARD * Add ts-standard * Update test case * Update test case * Add tsconfig.json * Add tsconfig.json environment value * Fix "TypeScript" * Fix package version * Fix package version * Fix package version * Fix package version * Fix settings * Remove config file env * Fix version * Fix eslintrc * Fix project path * Fix project path * Fix setting * Fix env * Add .eslintrc.yml for ts-standard * Fix README * Fix settings * Change include paths * Change include paths * Change include paths * Change include paths * Fix dependencies * Fix dependencies * Fix dependence versions
2022-03-16 11:21:57 -04:00
TYPESCRIPT_DEFAULT_STYLE="${TYPESCRIPT_DEFAULT_STYLE:-ts-standard}"
Typescript prettier (#2121) * adding typescript prettier * adding typescript prettier * fix scala
2021-11-12 11:25:32 -05:00
TYPESCRIPT_STYLE_NAME='' # Variable for the style
# shellcheck disable=SC2034 # Variable is referenced indirectly
Simplify rules files loading, plus fixes
2020-10-15 05:43:56 -04:00
TYPESCRIPT_ES_FILE_NAME="${TYPESCRIPT_ES_CONFIG_FILE:-.eslintrc.yml}"
adding find algorithm (#1640) * adding find * add default value
2021-06-08 11:40:59 -04:00
# shellcheck disable=SC2034 # Variable is referenced indirectly
Simplify rules files loading, plus fixes
2020-10-15 05:43:56 -04:00
YAML_FILE_NAME="${YAML_CONFIG_FILE:-.yaml-lint.yml}"
Add stylelint support to super-linter Added tests Updated readme with usage notes (disabling lines etc) to match existing content
2020-06-18 19:40:41 -04:00
Adding support for Prettier (#1118) * adding it * fix spaces * vars were backwards * remove prettier from function test
2021-01-04 12:07:57 -05:00
#################################################
# Parse if we are using JS standard or prettier #
#################################################
# Remove spaces
JAVASCRIPT_DEFAULT_STYLE=$(echo "${JAVASCRIPT_DEFAULT_STYLE}" | tr -d ' ')
# lowercase
JAVASCRIPT_DEFAULT_STYLE=$(echo "${JAVASCRIPT_DEFAULT_STYLE}" | tr '[:upper:]' '[:lower:]')
# Check and set
if [ "${JAVASCRIPT_DEFAULT_STYLE}" == "prettier" ]; then
# Set to prettier
JAVASCRIPT_STYLE_NAME='JAVASCRIPT_PRETTIER'
else
# Default to standard
JAVASCRIPT_STYLE_NAME='JAVASCRIPT_STANDARD'
fi
Typescript prettier (#2121) * adding typescript prettier * adding typescript prettier * fix scala
2021-11-12 11:25:32 -05:00
#################################################
# Parse if we are using JS standard or prettier #
#################################################
# Remove spaces
TYPESCRIPT_DEFAULT_STYLE=$(echo "${TYPESCRIPT_DEFAULT_STYLE}" | tr -d ' ')
# lowercase
TYPESCRIPT_DEFAULT_STYLE=$(echo "${TYPESCRIPT_DEFAULT_STYLE}" | tr '[:upper:]' '[:lower:]')
# Check and set
if [ "${TYPESCRIPT_DEFAULT_STYLE}" == "prettier" ]; then
# Set to prettier
TYPESCRIPT_STYLE_NAME='TYPESCRIPT_PRETTIER'
else
# Default to standard
TYPESCRIPT_STYLE_NAME='TYPESCRIPT_STANDARD'
fi
Dynamically invoke linters
2020-10-08 18:54:28 -04:00
##################
# Language array #
##################
feat: add support for checkov to lint iac files (#4925) - Add support to run Checkov against infrastructure as code descriptors that are in a given (configurable) directory. Defaults to lint the whole workspace. - Establish a baseline for our own codebase so we don't have to fix issues right away with this change.
2023-12-22 07:22:15 -05:00
LANGUAGE_ARRAY=('ANSIBLE' 'ARM' 'BASH' 'BASH_EXEC' 'CHECKOV' 'CLANG_FORMAT'
adding clang (#1762) * adding clang * fix hado * adding files * fixing naming * fixing test * fixing space * removing config file * fix tests * fix tests * fix file array
2021-07-14 15:43:10 -04:00
'CLOUDFORMATION' 'CLOJURE' 'COFFEESCRIPT' 'CPP' 'CSHARP' 'CSS' 'DART'
Uninstall Dockerfilelint (#2195) * Uninstall Dockerfilelint * remove dockerfilelint packages * trying ca-certs Co-authored-by: Admiral Awkbar <admiralawkbar@github.com>
2021-12-08 10:53:05 -05:00
'DOCKERFILE_HADOLINT' 'EDITORCONFIG' 'ENV' 'GITHUB_ACTIONS'
Lint Go modules (#4984) * Lint Go projects by directory * Search for Go modules * Fix test path * Add test cases and fix command * Change workdir * Add a warning about false positives * fatal instead of warn * Move tests to the test directory * Close group on fatal * Don't fail in test mode
2023-12-16 03:30:33 -05:00
'GITLEAKS' 'GHERKIN' 'GO' 'GO_MODULES' 'GOOGLE_JAVA_FORMAT' 'GROOVY' 'HTML' 'JAVA'
Enhancement: Add support for google-java-format (#1969) * Add support for google-java-format * adding tests and array * fix comma * Update linter.sh * get it in order * fix hava version Co-authored-by: Admiral Awkbar <admiralawkbar@github.com>
2021-09-28 18:09:21 -04:00
'JAVASCRIPT_ES' "${JAVASCRIPT_STYLE_NAME}" 'JSCPD' 'JSON' 'JSONC' 'JSX'
deps(java): bump com.pinterest.ktlint:ktlint-cli in /dependencies/ktlint (#5050) Remove KOTLIN_ANDROID because ktlint handles that case by reading a configuration setting in .editorconfig. Bumps [com.pinterest.ktlint:ktlint-cli](https://github.com/pinterest/ktlint) from 0.47.1 to 1.1.0. - [Release notes](https://github.com/pinterest/ktlint/releases) - [Changelog](https://github.com/pinterest/ktlint/blob/master/CHANGELOG.md) - [Commits](https://github.com/pinterest/ktlint/compare/0.47.1...1.1.0) --- updated-dependencies: - dependency-name: com.pinterest.ktlint:ktlint-cli dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-12-24 13:33:08 -05:00
'KUBERNETES_KUBECONFORM' 'KOTLIN' 'LATEX' 'LUA' 'MARKDOWN'
Add KOTLIN_ANDROID to LANGUAGE_ARRAY (#2689)
2022-03-28 09:55:45 -04:00
'NATURAL_LANGUAGE' 'OPENAPI' 'PERL' 'PHP_BUILTIN' 'PHP_PHPCS' 'PHP_PHPSTAN'
'PHP_PSALM' 'POWERSHELL' 'PROTOBUF' 'PYTHON_BLACK' 'PYTHON_PYLINT'
Add renovate-config-validator (#4643)
2023-09-12 12:58:09 -04:00
'PYTHON_FLAKE8' 'PYTHON_ISORT' 'PYTHON_MYPY' 'R' 'RAKU' 'RENOVATE' 'RUBY' 'RUST_2015'
Add KOTLIN_ANDROID to LANGUAGE_ARRAY (#2689)
2022-03-28 09:55:45 -04:00
'RUST_2018' 'RUST_2021' 'RUST_CLIPPY' 'SCALAFMT' 'SHELL_SHFMT'
'SNAKEMAKE_LINT' 'SNAKEMAKE_SNAKEFMT' 'STATES' 'SQL' 'SQLFLUFF' 'TEKTON'
fix failing lint
2022-12-23 05:26:32 -05:00
'TERRAFORM_FMT' 'TERRAFORM_TFLINT' 'TERRAFORM_TERRASCAN' 'TERRAGRUNT' 'TSX'
Add terraform fmt support
2022-12-23 03:58:50 -05:00
'TYPESCRIPT_ES' "${TYPESCRIPT_STYLE_NAME}" 'XML' 'YAML')
maybe this does it
2020-07-21 09:12:28 -04:00
adding more code
2019-10-25 15:22:57 -04:00
##########################
# Array of changed files #
##########################
Dynamically initialize FILE_ARRAY variables
2020-10-02 17:02:47 -04:00
for LANGUAGE in "${LANGUAGE_ARRAY[@]}"; do
FILE_ARRAY_VARIABLE_NAME="FILE_ARRAY_${LANGUAGE}"
debug "Setting ${FILE_ARRAY_VARIABLE_NAME} variable..."
eval "${FILE_ARRAY_VARIABLE_NAME}=()"
done
adding more code
2019-10-25 15:22:57 -04:00
initial commit
2019-10-21 10:12:50 -04:00
################################################################################
adding it
2019-10-21 12:05:55 -04:00
########################## FUNCTIONS BELOW #####################################
initial commit
2019-10-21 10:12:50 -04:00
################################################################################
################################################################################
adding it
2019-10-21 12:05:55 -04:00
#### Function Header ###########################################################
shfmt files
2020-07-01 17:40:40 -04:00
Header() {
with teeth
2020-05-06 11:03:06 -04:00
###############################
# Give them the possum action #
###############################
Adding Flag for Possum (#1149) * adding a bad feature * fix hadolint
2021-01-19 12:03:14 -05:00
if [[ "${SUPPRESS_POSSUM}" == "false" ]]; then
/bin/bash /action/lib/functions/possum.sh
fi
with teeth
2020-05-06 11:03:06 -04:00
##########
# Prints #
##########
Format (fix indentation)
2020-07-30 16:39:05 -04:00
info "---------------------------------------------"
info "--- GitHub Actions Multi Language Linter ----"
make pretty
2020-09-04 11:14:47 -04:00
info " - Image Creation Date:[${BUILD_DATE}]"
info " - Image Revision:[${BUILD_REVISION}]"
info " - Image Version:[${BUILD_VERSION}]"
Format (fix indentation)
2020-07-30 16:39:05 -04:00
info "---------------------------------------------"
info "---------------------------------------------"
info "The Super-Linter source code can be found at:"
Follow up with several more documentation and automation renames for the org move from github to super-linter (#4543) * move from github org to super-linter org * rename to super-linter org * rename to super-linter org * rename org to super-linter * rename org to super-linter * rename org to super-linter * rename org to super-linter * rename org to super-linter * rename org to super-linter * rename org to super-linter and remove dockerhub reference * rename org to super-linter * rename org to super-linter * rename org to super-linter * rename org to super-linter * rename org to super-linter * rename org to super-linter * rename org to super-linter * rename org to super-linter * rename org to super-linter * rename org to super-linter * rename org to super-linter * rm dockerhub section link
2023-08-17 11:12:11 -04:00
info " - https://github.com/super-linter/super-linter"
Format (fix indentation)
2020-07-30 16:39:05 -04:00
info "---------------------------------------------"
feat: validate variables and simplify lowercase (#5128) - Validate variables representing boolean values. - Group global variables in the same sections. - Declare variables as lowercase with the 'declare -l' shell builtin for more clarity.
2024-01-11 15:30:00 -05:00
if [[ ${VALIDATE_ALL_CODEBASE} != "false" ]]; then
VALIDATE_ALL_CODEBASE="true"
info "- Validating all files in code base..."
else
info "- Validating changed files in code base..."
fi
adding it
2019-10-21 12:05:55 -04:00
}
Don't forcefully validate Git repos if not needed (#4953) * Fix find when linting non-git repos * Remove uses * Move safe.directory config after we set GITHUB_WORKSPACE * Fix Git validation check * Move 'find' test runner to makefile * Validate vars before validating Git repo * Validate Git repo even when VALIDATE_ALL_CODEBASE=false * Initialize GITHUB_SHA when running locally * Initialize safe git dirs * Check git safe dirs error code * Fix log level color marker * Fix linting errors * Fix change dir command * Fix linting errors * Set default branch
2023-12-07 14:07:22 -05:00
ConfigureGitSafeDirectories() {
debug "Configuring Git safe directories"
declare -a git_safe_directories=("${GITHUB_WORKSPACE}" "${DEFAULT_SUPER_LINTER_WORKSPACE}" "${DEFAULT_WORKSPACE}")
for safe_directory in "${git_safe_directories[@]}"; do
debug "Set ${safe_directory} as a Git safe directory"
if ! git config --global --add safe.directory "${safe_directory}"; then
fatal "Cannot configure ${safe_directory} as a Git safe directory."
fi
done
}
adding it
2019-10-21 12:05:55 -04:00
################################################################################
cleaning
2019-10-21 15:12:37 -04:00
#### Function GetGitHubVars ####################################################
shfmt files
2020-07-01 17:40:40 -04:00
GetGitHubVars() {
cleaning
2019-10-21 15:12:37 -04:00
##########
# Prints #
##########
Format (fix indentation)
2020-07-30 16:39:05 -04:00
info "--------------------------------------------"
info "Gathering GitHub information..."
cleaning
2019-10-21 15:12:37 -04:00
feat: automatically set the default branch (#5242) Get the default branch from the GitHub Actions event payload when running on GitHub Actions. Default to 'master', as before, otherwise.
2024-02-08 03:41:07 -05:00
local GITHUB_REPOSITORY_DEFAULT_BRANCH
GITHUB_REPOSITORY_DEFAULT_BRANCH="master"
Variable braces
2020-07-21 13:09:07 -04:00
if [[ ${RUN_LOCAL} != "false" ]]; then
Don't forcefully validate Git repos if not needed (#4953) * Fix find when linting non-git repos * Remove uses * Move safe.directory config after we set GITHUB_WORKSPACE * Fix Git validation check * Move 'find' test runner to makefile * Validate vars before validating Git repo * Validate Git repo even when VALIDATE_ALL_CODEBASE=false * Initialize GITHUB_SHA when running locally * Initialize safe git dirs * Check git safe dirs error code * Fix log level color marker * Fix linting errors * Fix change dir command * Fix linting errors * Set default branch
2023-12-07 14:07:22 -05:00
info "RUN_LOCAL has been set to: ${RUN_LOCAL}. Bypassing GitHub Actions variables..."
Feat: Make GITHUB_WORKSPACE overridable in RUN_LOCAL Mode
2020-06-19 13:31:53 -04:00
Variable braces
2020-07-21 13:09:07 -04:00
if [ -z "${GITHUB_WORKSPACE}" ]; then
GITHUB_WORKSPACE="${DEFAULT_WORKSPACE}"
Feat: Make GITHUB_WORKSPACE overridable in RUN_LOCAL Mode
2020-06-19 13:31:53 -04:00
fi
creating files
2020-06-29 10:55:59 -04:00
feat: validate variables and simplify lowercase (#5128) - Validate variables representing boolean values. - Group global variables in the same sections. - Declare variables as lowercase with the 'declare -l' shell builtin for more clarity.
2024-01-11 15:30:00 -05:00
ValidateGitHubWorkspace "${GITHUB_WORKSPACE}"
Added check to ensure volume is directory ADDED - Present user with error when attempting to pass non-directory as volume
2020-07-06 17:57:30 -04:00
Change WORKDIR in script, not relying on docker run -w by user (#4821) * fix: #4459 * add exit code * misc fix
2023-11-05 00:29:52 -04:00
pushd "${GITHUB_WORKSPACE}" >/dev/null || exit 1
Adding logic
2020-01-09 11:29:18 -05:00
Don't forcefully validate Git repos if not needed (#4953) * Fix find when linting non-git repos * Remove uses * Move safe.directory config after we set GITHUB_WORKSPACE * Fix Git validation check * Move 'find' test runner to makefile * Validate vars before validating Git repo * Validate Git repo even when VALIDATE_ALL_CODEBASE=false * Initialize GITHUB_SHA when running locally * Initialize safe git dirs * Check git safe dirs error code * Fix log level color marker * Fix linting errors * Fix change dir command * Fix linting errors * Set default branch
2023-12-07 14:07:22 -05:00
if [[ "${USE_FIND_ALGORITHM}" == "false" ]]; then
ConfigureGitSafeDirectories
debug "Initializing GITHUB_SHA considering ${GITHUB_WORKSPACE}"
chore: simplify error code checks (#5131) Instead of loading the error code and checking it, shorten checks by running the command directly.
2024-01-30 02:48:24 -05:00
if ! GITHUB_SHA=$(git -C "${GITHUB_WORKSPACE}" rev-parse HEAD); then
Don't forcefully validate Git repos if not needed (#4953) * Fix find when linting non-git repos * Remove uses * Move safe.directory config after we set GITHUB_WORKSPACE * Fix Git validation check * Move 'find' test runner to makefile * Validate vars before validating Git repo * Validate Git repo even when VALIDATE_ALL_CODEBASE=false * Initialize GITHUB_SHA when running locally * Initialize safe git dirs * Check git safe dirs error code * Fix log level color marker * Fix linting errors * Fix change dir command * Fix linting errors * Set default branch
2023-12-07 14:07:22 -05:00
fatal "Failed to initialize GITHUB_SHA. Output: ${GITHUB_SHA}"
fi
debug "GITHUB_SHA: ${GITHUB_SHA}"
else
debug "Skip the initalization of GITHUB_SHA because we don't need it"
fi
Simplify multi status checks (#4958)
2023-12-14 15:22:49 -05:00
MULTI_STATUS="false"
debug "Setting MULTI_STATUS to ${MULTI_STATUS} because we are not running on GitHub Actions"
cleaning
2019-10-21 15:12:37 -04:00
else
feat: validate variables and simplify lowercase (#5128) - Validate variables representing boolean values. - Group global variables in the same sections. - Declare variables as lowercase with the 'declare -l' shell builtin for more clarity.
2024-01-11 15:30:00 -05:00
ValidateGitHubWorkspace "${GITHUB_WORKSPACE}"
cleaning
2019-10-21 15:12:37 -04:00
fix: fix GITHUB_BEFORE_SHA diff on push events (#5096) - Fix GITHUB_BEFORE_SHA initialization on push events by setting the correct key. - Add an additional check against setting GITHUB_BEFORE_SHA to null. - Run the CI workflow on push events to trigger required status checks when using the merge queue.
2024-01-04 16:54:47 -05:00
# Ensure that Git can access the local repository
ConfigureGitSafeDirectories
Variable braces
2020-07-21 13:09:07 -04:00
if [ -z "${GITHUB_EVENT_PATH}" ]; then
fix: fix GITHUB_BEFORE_SHA diff on push events (#5096) - Fix GITHUB_BEFORE_SHA initialization on push events by setting the correct key. - Add an additional check against setting GITHUB_BEFORE_SHA to null. - Run the CI workflow on push events to trigger required status checks when using the merge queue.
2024-01-04 16:54:47 -05:00
fatal "Failed to get GITHUB_EVENT_PATH: ${GITHUB_EVENT_PATH}]"
Adding logic
2020-01-09 11:29:18 -05:00
else
fix: simplify worker and linterVersions (#5123) - Remove the SKIP_FLAG variable and check for the length of the arrays of files to lint directly. - Remove the LIST_FILES variable, and use the FILE_ARRAY variable directly. - Remove the corner case for RENOVATE because renovate-config-validator supports passing the path to the file to lint using an argument as the default case does. - Remove the corner case for ANSIBLE not having 'bad' tests because it has them now. - Set TF_DATA_DIR to avoid any modification to any existing Terraform data directory that users might have in their workspace. - Aggregate GO_MODULES and ANSIBLE corner cases because they are the same. - Remove the corner case for ANSIBLE to add a trailing slash to TEST_CASE_FOLDER (similar reason as the previous point about ANSIBLE corner case). - Simplify log messages by removing color markers because they are already handled in log.sh. - Simplify linterVersions by removing redundant checks and functions. - Avoid printing debug logs in the versions file.
2024-01-15 13:37:45 -05:00
info "Successfully found GITHUB_EVENT_PATH: ${GITHUB_EVENT_PATH}]"
fix: fix GITHUB_BEFORE_SHA diff on push events (#5096) - Fix GITHUB_BEFORE_SHA initialization on push events by setting the correct key. - Add an additional check against setting GITHUB_BEFORE_SHA to null. - Run the CI workflow on push events to trigger required status checks when using the merge queue.
2024-01-04 16:54:47 -05:00
debug "${GITHUB_EVENT_PATH} contents: $(cat "${GITHUB_EVENT_PATH}")"
Adding logic
2020-01-09 11:29:18 -05:00
fi
cleaning
2019-10-21 15:12:37 -04:00
Exit on errors when running Git (#4889) * Exit on errors when running Git * Skip pulling changes entirely * Enable pipefail when generating diffs * Cleanup * Shallow repo check * Echo GITHUB_SHA update * Check if GITHUB_SHA exists before using it * Move GITHUB_SHA validation to validation script * Rely on cat-file return code * Check if DEFAULT_BRANCH exists * Change dir when checking DEFAULT_BRANCH * Show git branches * Don't switch branches * Check GITHUB_SHA only when needed * Ensure we have permissions before interacting with the repo * Remove the DIFF_CMD variable * Move TEST_CASE_RUN and RUN_LOCAL init up * Validate if Git repo and if SHA exists * Move validation function * Change dir when getting branch names * Move debug messages up to be less verbose * Move branch validation in a function * Fix linting errors
2023-12-04 04:47:49 -05:00
if [ -z "${GITHUB_SHA}" ]; then
fix: fix GITHUB_BEFORE_SHA diff on push events (#5096) - Fix GITHUB_BEFORE_SHA initialization on push events by setting the correct key. - Add an additional check against setting GITHUB_BEFORE_SHA to null. - Run the CI workflow on push events to trigger required status checks when using the merge queue.
2024-01-04 16:54:47 -05:00
fatal "Failed to get GITHUB_SHA: ${GITHUB_SHA}"
Exit on errors when running Git (#4889) * Exit on errors when running Git * Skip pulling changes entirely * Enable pipefail when generating diffs * Cleanup * Shallow repo check * Echo GITHUB_SHA update * Check if GITHUB_SHA exists before using it * Move GITHUB_SHA validation to validation script * Rely on cat-file return code * Check if DEFAULT_BRANCH exists * Change dir when checking DEFAULT_BRANCH * Show git branches * Don't switch branches * Check GITHUB_SHA only when needed * Ensure we have permissions before interacting with the repo * Remove the DIFF_CMD variable * Move TEST_CASE_RUN and RUN_LOCAL init up * Validate if Git repo and if SHA exists * Move validation function * Change dir when getting branch names * Move debug messages up to be less verbose * Move branch validation in a function * Fix linting errors
2023-12-04 04:47:49 -05:00
else
fix: simplify worker and linterVersions (#5123) - Remove the SKIP_FLAG variable and check for the length of the arrays of files to lint directly. - Remove the LIST_FILES variable, and use the FILE_ARRAY variable directly. - Remove the corner case for RENOVATE because renovate-config-validator supports passing the path to the file to lint using an argument as the default case does. - Remove the corner case for ANSIBLE not having 'bad' tests because it has them now. - Set TF_DATA_DIR to avoid any modification to any existing Terraform data directory that users might have in their workspace. - Aggregate GO_MODULES and ANSIBLE corner cases because they are the same. - Remove the corner case for ANSIBLE to add a trailing slash to TEST_CASE_FOLDER (similar reason as the previous point about ANSIBLE corner case). - Simplify log messages by removing color markers because they are already handled in log.sh. - Simplify linterVersions by removing redundant checks and functions. - Avoid printing debug logs in the versions file.
2024-01-15 13:37:45 -05:00
info "Successfully found GITHUB_SHA: ${GITHUB_SHA}"
Exit on errors when running Git (#4889) * Exit on errors when running Git * Skip pulling changes entirely * Enable pipefail when generating diffs * Cleanup * Shallow repo check * Echo GITHUB_SHA update * Check if GITHUB_SHA exists before using it * Move GITHUB_SHA validation to validation script * Rely on cat-file return code * Check if DEFAULT_BRANCH exists * Change dir when checking DEFAULT_BRANCH * Show git branches * Don't switch branches * Check GITHUB_SHA only when needed * Ensure we have permissions before interacting with the repo * Remove the DIFF_CMD variable * Move TEST_CASE_RUN and RUN_LOCAL init up * Validate if Git repo and if SHA exists * Move validation function * Change dir when getting branch names * Move debug messages up to be less verbose * Move branch validation in a function * Fix linting errors
2023-12-04 04:47:49 -05:00
fi
Adding logic
2020-01-09 11:29:18 -05:00
##################################################
# Need to pull the GitHub Vars from the env file #
##################################################
Add management of FILTER_REGEX_INCLUDE and FILTER_REGEX_EXCLUDE options
2020-09-05 06:25:44 -04:00
GITHUB_ORG=$(jq -r '.repository.owner.login' <"${GITHUB_EVENT_PATH}")
Adding logic
2020-01-09 11:29:18 -05:00
Fix get file diff on pr event (#1305) * Fix pr event sha * Improve cmd * Fix space
2021-03-04 14:51:44 -05:00
# Github sha on PR events is not the latest commit.
# https://docs.github.com/en/actions/reference/events-that-trigger-workflows#pull_request
if [ "$GITHUB_EVENT_NAME" == "pull_request" ]; then
fix: fix GITHUB_BEFORE_SHA diff on push events (#5096) - Fix GITHUB_BEFORE_SHA initialization on push events by setting the correct key. - Add an additional check against setting GITHUB_BEFORE_SHA to null. - Run the CI workflow on push events to trigger required status checks when using the merge queue.
2024-01-04 16:54:47 -05:00
debug "This is a GitHub pull request. Updating the current GITHUB_SHA (${GITHUB_SHA}) to the pull request HEAD SHA"
Exit on errors when running Git (#4889) * Exit on errors when running Git * Skip pulling changes entirely * Enable pipefail when generating diffs * Cleanup * Shallow repo check * Echo GITHUB_SHA update * Check if GITHUB_SHA exists before using it * Move GITHUB_SHA validation to validation script * Rely on cat-file return code * Check if DEFAULT_BRANCH exists * Change dir when checking DEFAULT_BRANCH * Show git branches * Don't switch branches * Check GITHUB_SHA only when needed * Ensure we have permissions before interacting with the repo * Remove the DIFF_CMD variable * Move TEST_CASE_RUN and RUN_LOCAL init up * Validate if Git repo and if SHA exists * Move validation function * Change dir when getting branch names * Move debug messages up to be less verbose * Move branch validation in a function * Fix linting errors
2023-12-04 04:47:49 -05:00
chore: simplify error code checks (#5131) Instead of loading the error code and checking it, shorten checks by running the command directly.
2024-01-30 02:48:24 -05:00
if ! GITHUB_SHA=$(jq -r .pull_request.head.sha <"$GITHUB_EVENT_PATH"); then
fix: fix GITHUB_BEFORE_SHA diff on push events (#5096) - Fix GITHUB_BEFORE_SHA initialization on push events by setting the correct key. - Add an additional check against setting GITHUB_BEFORE_SHA to null. - Run the CI workflow on push events to trigger required status checks when using the merge queue.
2024-01-04 16:54:47 -05:00
fatal "Failed to update GITHUB_SHA for pull request event: ${GITHUB_SHA}"
Exit on errors when running Git (#4889) * Exit on errors when running Git * Skip pulling changes entirely * Enable pipefail when generating diffs * Cleanup * Shallow repo check * Echo GITHUB_SHA update * Check if GITHUB_SHA exists before using it * Move GITHUB_SHA validation to validation script * Rely on cat-file return code * Check if DEFAULT_BRANCH exists * Change dir when checking DEFAULT_BRANCH * Show git branches * Don't switch branches * Check GITHUB_SHA only when needed * Ensure we have permissions before interacting with the repo * Remove the DIFF_CMD variable * Move TEST_CASE_RUN and RUN_LOCAL init up * Validate if Git repo and if SHA exists * Move validation function * Change dir when getting branch names * Move debug messages up to be less verbose * Move branch validation in a function * Fix linting errors
2023-12-04 04:47:49 -05:00
fi
debug "Updated GITHUB_SHA: ${GITHUB_SHA}"
fix: fix file list when looking for changes (#5044) - Fix the file diff function on push events. - Implement a test for the file diff function
2023-12-23 13:33:53 -05:00
elif [ "${GITHUB_EVENT_NAME}" == "push" ]; then
debug "This is a GitHub push event."
fix: fix GITHUB_BEFORE_SHA initalization for push (#5098)
2024-01-05 17:07:39 -05:00
GITHUB_PUSH_COMMIT_COUNT=$(GetGithubPushEventCommitCount "$GITHUB_EVENT_PATH")
if [ -z "${GITHUB_PUSH_COMMIT_COUNT}" ]; then
fatal "Failed to get GITHUB_PUSH_COMMIT_COUNT"
fix: fix GITHUB_BEFORE_SHA diff on push events (#5096) - Fix GITHUB_BEFORE_SHA initialization on push events by setting the correct key. - Add an additional check against setting GITHUB_BEFORE_SHA to null. - Run the CI workflow on push events to trigger required status checks when using the merge queue.
2024-01-04 16:54:47 -05:00
fi
fix: simplify worker and linterVersions (#5123) - Remove the SKIP_FLAG variable and check for the length of the arrays of files to lint directly. - Remove the LIST_FILES variable, and use the FILE_ARRAY variable directly. - Remove the corner case for RENOVATE because renovate-config-validator supports passing the path to the file to lint using an argument as the default case does. - Remove the corner case for ANSIBLE not having 'bad' tests because it has them now. - Set TF_DATA_DIR to avoid any modification to any existing Terraform data directory that users might have in their workspace. - Aggregate GO_MODULES and ANSIBLE corner cases because they are the same. - Remove the corner case for ANSIBLE to add a trailing slash to TEST_CASE_FOLDER (similar reason as the previous point about ANSIBLE corner case). - Simplify log messages by removing color markers because they are already handled in log.sh. - Simplify linterVersions by removing redundant checks and functions. - Avoid printing debug logs in the versions file.
2024-01-15 13:37:45 -05:00
info "Successfully found GITHUB_PUSH_COMMIT_COUNT: ${GITHUB_PUSH_COMMIT_COUNT}"
fix: fix GITHUB_BEFORE_SHA diff on push events (#5096) - Fix GITHUB_BEFORE_SHA initialization on push events by setting the correct key. - Add an additional check against setting GITHUB_BEFORE_SHA to null. - Run the CI workflow on push events to trigger required status checks when using the merge queue.
2024-01-04 16:54:47 -05:00
fix: fix GITHUB_BEFORE_SHA initalization for push (#5098)
2024-01-05 17:07:39 -05:00
# Ref: https://docs.github.com/en/actions/learn-github-actions/contexts#github-context
debug "Get the hash of the commit to start the diff from from Git because the GitHub push event payload may not contain references to base_ref or previous commit."
# shellcheck disable=SC2086 # We checked that GITHUB_PUSH_COMMIT_COUNT is an integer
chore: simplify error code checks (#5131) Instead of loading the error code and checking it, shorten checks by running the command directly.
2024-01-30 02:48:24 -05:00
if ! GITHUB_BEFORE_SHA=$(git -C "${GITHUB_WORKSPACE}" rev-parse HEAD~${GITHUB_PUSH_COMMIT_COUNT}); then
fix: fix file list when looking for changes (#5044) - Fix the file diff function on push events. - Implement a test for the file diff function
2023-12-23 13:33:53 -05:00
fatal "Failed to initialize GITHUB_BEFORE_SHA for a push event. Output: ${GITHUB_BEFORE_SHA}"
fi
fix: fix GITHUB_BEFORE_SHA initalization for push (#5098)
2024-01-05 17:07:39 -05:00
ValidateGitBeforeShaReference
fix: simplify worker and linterVersions (#5123) - Remove the SKIP_FLAG variable and check for the length of the arrays of files to lint directly. - Remove the LIST_FILES variable, and use the FILE_ARRAY variable directly. - Remove the corner case for RENOVATE because renovate-config-validator supports passing the path to the file to lint using an argument as the default case does. - Remove the corner case for ANSIBLE not having 'bad' tests because it has them now. - Set TF_DATA_DIR to avoid any modification to any existing Terraform data directory that users might have in their workspace. - Aggregate GO_MODULES and ANSIBLE corner cases because they are the same. - Remove the corner case for ANSIBLE to add a trailing slash to TEST_CASE_FOLDER (similar reason as the previous point about ANSIBLE corner case). - Simplify log messages by removing color markers because they are already handled in log.sh. - Simplify linterVersions by removing redundant checks and functions. - Avoid printing debug logs in the versions file.
2024-01-15 13:37:45 -05:00
info "Successfully found GITHUB_BEFORE_SHA: ${GITHUB_BEFORE_SHA}"
Fix get file diff on pr event (#1305) * Fix pr event sha * Improve cmd * Fix space
2021-03-04 14:51:44 -05:00
fi
Adding logic
2020-01-09 11:29:18 -05:00
############################
# Validate we have a value #
############################
Variable braces
2020-07-21 13:09:07 -04:00
if [ -z "${GITHUB_ORG}" ]; then
Format (fix indentation)
2020-07-30 16:39:05 -04:00
error "Failed to get [GITHUB_ORG]!"
fatal "[${GITHUB_ORG}]"
Adding logic
2020-01-09 11:29:18 -05:00
else
fix: simplify worker and linterVersions (#5123) - Remove the SKIP_FLAG variable and check for the length of the arrays of files to lint directly. - Remove the LIST_FILES variable, and use the FILE_ARRAY variable directly. - Remove the corner case for RENOVATE because renovate-config-validator supports passing the path to the file to lint using an argument as the default case does. - Remove the corner case for ANSIBLE not having 'bad' tests because it has them now. - Set TF_DATA_DIR to avoid any modification to any existing Terraform data directory that users might have in their workspace. - Aggregate GO_MODULES and ANSIBLE corner cases because they are the same. - Remove the corner case for ANSIBLE to add a trailing slash to TEST_CASE_FOLDER (similar reason as the previous point about ANSIBLE corner case). - Simplify log messages by removing color markers because they are already handled in log.sh. - Simplify linterVersions by removing redundant checks and functions. - Avoid printing debug logs in the versions file.
2024-01-15 13:37:45 -05:00
info "Successfully found GITHUB_ORG: ${GITHUB_ORG}"
Adding logic
2020-01-09 11:29:18 -05:00
fi
#######################
# Get the GitHub Repo #
#######################
Add management of FILTER_REGEX_INCLUDE and FILTER_REGEX_EXCLUDE options
2020-09-05 06:25:44 -04:00
GITHUB_REPO=$(jq -r '.repository.name' <"${GITHUB_EVENT_PATH}")
Adding logic
2020-01-09 11:29:18 -05:00
############################
# Validate we have a value #
############################
Variable braces
2020-07-21 13:09:07 -04:00
if [ -z "${GITHUB_REPO}" ]; then
Format (fix indentation)
2020-07-30 16:39:05 -04:00
error "Failed to get [GITHUB_REPO]!"
fatal "[${GITHUB_REPO}]"
Adding logic
2020-01-09 11:29:18 -05:00
else
fix: simplify worker and linterVersions (#5123) - Remove the SKIP_FLAG variable and check for the length of the arrays of files to lint directly. - Remove the LIST_FILES variable, and use the FILE_ARRAY variable directly. - Remove the corner case for RENOVATE because renovate-config-validator supports passing the path to the file to lint using an argument as the default case does. - Remove the corner case for ANSIBLE not having 'bad' tests because it has them now. - Set TF_DATA_DIR to avoid any modification to any existing Terraform data directory that users might have in their workspace. - Aggregate GO_MODULES and ANSIBLE corner cases because they are the same. - Remove the corner case for ANSIBLE to add a trailing slash to TEST_CASE_FOLDER (similar reason as the previous point about ANSIBLE corner case). - Simplify log messages by removing color markers because they are already handled in log.sh. - Simplify linterVersions by removing redundant checks and functions. - Avoid printing debug logs in the versions file.
2024-01-15 13:37:45 -05:00
info "Successfully found GITHUB_REPO: ${GITHUB_REPO}"
Adding logic
2020-01-09 11:29:18 -05:00
fi
feat: automatically set the default branch (#5242) Get the default branch from the GitHub Actions event payload when running on GitHub Actions. Default to 'master', as before, otherwise.
2024-02-08 03:41:07 -05:00
GITHUB_REPOSITORY_DEFAULT_BRANCH=$(GetGithubRepositoryDefaultBranch "${GITHUB_EVENT_PATH}")
fi
if [ -z "${GITHUB_REPOSITORY_DEFAULT_BRANCH}" ]; then
fatal "Failed to get GITHUB_REPOSITORY_DEFAULT_BRANCH"
else
debug "Successfully detected the default branch for this repository: ${GITHUB_REPOSITORY_DEFAULT_BRANCH}"
fi
DEFAULT_BRANCH="${DEFAULT_BRANCH:-${GITHUB_REPOSITORY_DEFAULT_BRANCH}}"
if [[ "${DEFAULT_BRANCH}" != "${GITHUB_REPOSITORY_DEFAULT_BRANCH}" ]]; then
debug "The default branch for this repository was set to ${GITHUB_REPOSITORY_DEFAULT_BRANCH}, but it was explicitly overridden using the DEFAULT_BRANCH variable, and set to: ${DEFAULT_BRANCH}"
cleaning
2019-10-21 15:12:37 -04:00
fi
feat: automatically set the default branch (#5242) Get the default branch from the GitHub Actions event payload when running on GitHub Actions. Default to 'master', as before, otherwise.
2024-02-08 03:41:07 -05:00
info "The default branch for this repository is set to: ${DEFAULT_BRANCH}"
adding the code
2020-07-20 15:07:56 -04:00
Simplify multi status checks (#4958)
2023-12-14 15:22:49 -05:00
if [ "${MULTI_STATUS}" == "true" ]; then
adding the code
2020-07-20 15:07:56 -04:00
Simplify multi status checks (#4958)
2023-12-14 15:22:49 -05:00
if [[ ${RUN_LOCAL} == "true" ]]; then
# Safety check. This shouldn't occur because we forcefully set MULTI_STATUS=false above
# when RUN_LOCAL=true
fatal "Cannot enable status reports when running locally."
fi
if [ -z "${GITHUB_TOKEN}" ]; then
fatal "Failed to get [GITHUB_TOKEN]. Terminating because status reports were explicitly enabled, but GITHUB_TOKEN was not provided."
else
fix: simplify worker and linterVersions (#5123) - Remove the SKIP_FLAG variable and check for the length of the arrays of files to lint directly. - Remove the LIST_FILES variable, and use the FILE_ARRAY variable directly. - Remove the corner case for RENOVATE because renovate-config-validator supports passing the path to the file to lint using an argument as the default case does. - Remove the corner case for ANSIBLE not having 'bad' tests because it has them now. - Set TF_DATA_DIR to avoid any modification to any existing Terraform data directory that users might have in their workspace. - Aggregate GO_MODULES and ANSIBLE corner cases because they are the same. - Remove the corner case for ANSIBLE to add a trailing slash to TEST_CASE_FOLDER (similar reason as the previous point about ANSIBLE corner case). - Simplify log messages by removing color markers because they are already handled in log.sh. - Simplify linterVersions by removing redundant checks and functions. - Avoid printing debug logs in the versions file.
2024-01-15 13:37:45 -05:00
info "Successfully found GITHUB_TOKEN."
Simplify multi status checks (#4958)
2023-12-14 15:22:49 -05:00
fi
adding the code
2020-07-20 15:07:56 -04:00
Variable braces
2020-07-21 13:09:07 -04:00
if [ -z "${GITHUB_REPOSITORY}" ]; then
Format (fix indentation)
2020-07-30 16:39:05 -04:00
error "Failed to get [GITHUB_REPOSITORY]!"
fatal "[${GITHUB_REPOSITORY}]"
adding the code
2020-07-20 15:07:56 -04:00
else
fix: simplify worker and linterVersions (#5123) - Remove the SKIP_FLAG variable and check for the length of the arrays of files to lint directly. - Remove the LIST_FILES variable, and use the FILE_ARRAY variable directly. - Remove the corner case for RENOVATE because renovate-config-validator supports passing the path to the file to lint using an argument as the default case does. - Remove the corner case for ANSIBLE not having 'bad' tests because it has them now. - Set TF_DATA_DIR to avoid any modification to any existing Terraform data directory that users might have in their workspace. - Aggregate GO_MODULES and ANSIBLE corner cases because they are the same. - Remove the corner case for ANSIBLE to add a trailing slash to TEST_CASE_FOLDER (similar reason as the previous point about ANSIBLE corner case). - Simplify log messages by removing color markers because they are already handled in log.sh. - Simplify linterVersions by removing redundant checks and functions. - Avoid printing debug logs in the versions file.
2024-01-15 13:37:45 -05:00
info "Successfully found GITHUB_REPOSITORY: ${GITHUB_REPOSITORY}"
adding the code
2020-07-20 15:07:56 -04:00
fi
Variable braces
2020-07-21 13:09:07 -04:00
if [ -z "${GITHUB_RUN_ID}" ]; then
Format (fix indentation)
2020-07-30 16:39:05 -04:00
error "Failed to get [GITHUB_RUN_ID]!"
fatal "[${GITHUB_RUN_ID}]"
Adding logic
2020-01-09 11:29:18 -05:00
else
fix: simplify worker and linterVersions (#5123) - Remove the SKIP_FLAG variable and check for the length of the arrays of files to lint directly. - Remove the LIST_FILES variable, and use the FILE_ARRAY variable directly. - Remove the corner case for RENOVATE because renovate-config-validator supports passing the path to the file to lint using an argument as the default case does. - Remove the corner case for ANSIBLE not having 'bad' tests because it has them now. - Set TF_DATA_DIR to avoid any modification to any existing Terraform data directory that users might have in their workspace. - Aggregate GO_MODULES and ANSIBLE corner cases because they are the same. - Remove the corner case for ANSIBLE to add a trailing slash to TEST_CASE_FOLDER (similar reason as the previous point about ANSIBLE corner case). - Simplify log messages by removing color markers because they are already handled in log.sh. - Simplify linterVersions by removing redundant checks and functions. - Avoid printing debug logs in the versions file.
2024-01-15 13:37:45 -05:00
info "Successfully found GITHUB_RUN_ID ${GITHUB_RUN_ID}"
Adding logic
2020-01-09 11:29:18 -05:00
fi
fix: initialize GitHub domain variable (#5216) - Initialize GITHUB_DOMAIN as documented in the README - Configure other URLs according to GITHUB_DOMAIN - Automatically fetch SSH key fingerprints for GITHUB_DOMAINS
2024-02-09 13:45:44 -05:00
GITHUB_STATUS_URL="${GITHUB_API_URL}/repos/${GITHUB_REPOSITORY}/statuses/${GITHUB_SHA}"
debug "GitHub Status URL: ${GITHUB_STATUS_URL}"
GITHUB_STATUS_TARGET_URL="${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}/actions/runs/${GITHUB_RUN_ID}"
debug "GitHub Status target URL: ${GITHUB_STATUS_TARGET_URL}"
Simplify multi status checks (#4958)
2023-12-14 15:22:49 -05:00
else
debug "Skip GITHUB_TOKEN, GITHUB_REPOSITORY, and GITHUB_RUN_ID validation because we don't need these variables for GitHub Actions status reports. MULTI_STATUS: ${MULTI_STATUS}"
cleaning
2019-10-21 15:12:37 -04:00
fi
feat: run linters in parallel (#5177)
2024-01-30 14:24:55 -05:00
# We need this for parallel
export GITHUB_WORKSPACE
Cleanup of linter rules prints:
2020-04-27 13:21:38 -04:00
}
################################################################################
adding the code
2020-07-20 15:07:56 -04:00
#### Function CallStatusAPI ####################################################
CallStatusAPI() {
####################
# Pull in the vars #
####################
Fix typo on linter.sh Replace `langauge` with `language`.
2023-03-19 01:54:32 -04:00
LANGUAGE="${1}" # language that was validated
Format (fix indentation)
2020-07-30 16:39:05 -04:00
STATUS="${2}" # success | error
adding the code
2020-07-20 15:07:56 -04:00
SUCCESS_MSG='No errors were found in the linting process'
FAIL_MSG='Errors were detected, please view logs'
Format (fix indentation)
2020-07-30 16:39:05 -04:00
MESSAGE='' # Message to send to status API
adding the code
2020-07-20 15:07:56 -04:00
Add debug info for multi status api calls (#1287) * Add debug info for multi status api calls * Add test for clean action * Add more verbose * Test in action context * Test use local build as action * Improve debug for raw file array * Fix shallow fetch * Fix error messages on diff cmd * Changed repeated code to function * Fix quotes
2021-03-02 09:29:12 -05:00
debug "Calling Multi-Status API for $LANGUAGE with status $STATUS"
adding the code
2020-07-20 15:07:56 -04:00
######################################
# Check the status to create message #
######################################
Variable braces
2020-07-21 13:09:07 -04:00
if [ "${STATUS}" == "success" ]; then
adding the code
2020-07-20 15:07:56 -04:00
# Success
Variable braces
2020-07-21 13:09:07 -04:00
MESSAGE="${SUCCESS_MSG}"
adding the code
2020-07-20 15:07:56 -04:00
else
# Failure
Variable braces
2020-07-21 13:09:07 -04:00
MESSAGE="${FAIL_MSG}"
adding the code
2020-07-20 15:07:56 -04:00
fi
Adding logic to skip status without proper data
2020-07-21 11:13:15 -04:00
##########################################################
# Check to see if were enabled for multi Status mesaages #
##########################################################
quotes
2020-08-19 15:18:49 -04:00
if [ "${MULTI_STATUS}" == "true" ] && [ -n "${GITHUB_TOKEN}" ] && [ -n "${GITHUB_REPOSITORY}" ]; then
Cleaner solution
2020-09-03 19:37:10 -04:00
# make sure we honor DISABLE_ERRORS
if [ "${DISABLE_ERRORS}" == "true" ]; then
STATUS="success"
fi
Adding logic to skip status without proper data
2020-07-21 11:13:15 -04:00
##############################################
# Call the status API to create status check #
##############################################
chore: simplify error code checks (#5131) Instead of loading the error code and checking it, shorten checks by running the command directly.
2024-01-30 02:48:24 -05:00
if ! SEND_STATUS_CMD=$(
Build process improvements (#3367) * Fix issues with the container image build * Fix asl-validator version check * Disable filename rule when running ktlint tests * Bump asl-validator from 2.2.1 to 3.0.8 in /dependencies Bumps [asl-validator](https://github.com/ChristopheBougere/asl-validator) from 2.2.1 to 3.0.8. - [Release notes](https://github.com/ChristopheBougere/asl-validator/releases) - [Commits](https://github.com/ChristopheBougere/asl-validator/compare/2.2.1...3.0.8) --- updated-dependencies: - dependency-name: asl-validator dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> * Show errors when using curl to call the status API * Make the build more reproducible Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2022-09-28 09:45:01 -04:00
curl -f -s --show-error -X POST \
fix: initialize GitHub domain variable (#5216) - Initialize GITHUB_DOMAIN as documented in the README - Configure other URLs according to GITHUB_DOMAIN - Automatically fetch SSH key fingerprints for GITHUB_DOMAINS
2024-02-09 13:45:44 -05:00
--url "${GITHUB_STATUS_URL}" \
Fix file filters: Reorder arguments to LintCodeBase function
2020-09-15 01:44:55 -04:00
-H 'accept: application/vnd.github.v3+json' \
-H "authorization: Bearer ${GITHUB_TOKEN}" \
-H 'content-type: application/json' \
-d "{ \"state\": \"${STATUS}\",
fix: initialize GitHub domain variable (#5216) - Initialize GITHUB_DOMAIN as documented in the README - Configure other URLs according to GITHUB_DOMAIN - Automatically fetch SSH key fingerprints for GITHUB_DOMAINS
2024-02-09 13:45:44 -05:00
\"target_url\": \"${GITHUB_STATUS_TARGET_URL}\",
Variable braces
2020-07-21 13:09:07 -04:00
\"description\": \"${MESSAGE}\", \"context\": \"--> Linted: ${LANGUAGE}\"
Solve conflicts + format
2020-09-09 14:22:32 -04:00
}" 2>&1
chore: simplify error code checks (#5131) Instead of loading the error code and checking it, shorten checks by running the command directly.
2024-01-30 02:48:24 -05:00
); then
Don't write colors and logs on disk if not necessary (#4934) * Don't write colors and logs on disk if not necessary * Set color markers * Fix colors * Fix linting errors * Fix linting errors * Use sudo to access logs
2023-12-05 03:04:13 -05:00
info "Failed to call GitHub Status API: ${SEND_STATUS_CMD}"
Made it a function and put in better place
2020-07-01 08:49:17 -04:00
fi
fi
}
feat: run linters in parallel (#5177)
2024-01-30 14:24:55 -05:00
making cool moves
2020-07-22 15:49:26 -04:00
Footer() {
Format (fix indentation)
2020-07-30 16:39:05 -04:00
info "----------------------------------------------"
info "----------------------------------------------"
making cool moves
2020-07-22 15:49:26 -04:00
feat: run linters in parallel (#5177)
2024-01-30 14:24:55 -05:00
local ANY_LINTER_SUCCESS
ANY_LINTER_SUCCESS="false"
local SUPER_LINTER_EXIT_CODE
SUPER_LINTER_EXIT_CODE=0
this shoudl be better
2020-07-21 09:23:32 -04:00
shfmt files
2020-07-01 17:40:40 -04:00
for LANGUAGE in "${LANGUAGE_ARRAY[@]}"; do
feat: run linters in parallel (#5177)
2024-01-30 14:24:55 -05:00
# This used to be the count of errors found for a given LANGUAGE, but since
# after we switched to running linters against a batch of files, it may not
# represent the actual number of files that didn't pass the validation,
# but a number that's less than that because of how GNU parallel returns
# exit codes.
# Ref: https://www.gnu.org/software/parallel/parallel.html#exit-status
ERROR_COUNTER_FILE_PATH="/tmp/super-linter-parallel-command-exit-code-${LANGUAGE}"
if [ ! -f "${ERROR_COUNTER_FILE_PATH}" ]; then
debug "Error counter ${ERROR_COUNTER_FILE_PATH} doesn't exist"
else
ERROR_COUNTER=$(<"${ERROR_COUNTER_FILE_PATH}")
debug "ERROR_COUNTER for ${LANGUAGE}: ${ERROR_COUNTER}"
if [[ ${ERROR_COUNTER} -ne 0 ]]; then
error "Errors found in ${LANGUAGE}"
feat: show error output when info is disabled (#5251) In case of linting errors, print stdout and stderr (if present) at the ERROR level if users set LOG_LEVEL to NOTICE to avoid failures without any explanation.
2024-02-10 04:16:31 -05:00
# Print output as error in case users disabled the INFO level so they
# get feedback
if [[ "${LOG_VERBOSE}" != "true" ]]; then
local STDOUT_LINTER_FILE_PATH
STDOUT_LINTER_FILE_PATH="/tmp/super-linter-parallel-stdout-${LANGUAGE}"
if [[ -e "${STDOUT_LINTER_FILE_PATH}" ]]; then
error "$(cat "${STDOUT_LINTER_FILE_PATH}")"
else
debug "Stdout output file path for ${LANGUAGE} (${STDOUT_LINTER_FILE_PATH}) doesn't exist"
fi
local STDERR_LINTER_FILE_PATH
STDERR_LINTER_FILE_PATH="/tmp/super-linter-parallel-stderr-${LANGUAGE}"
if [[ -e "${STDERR_LINTER_FILE_PATH}" ]]; then
error "$(cat "${STDERR_LINTER_FILE_PATH}")"
else
debug "Stderr output file path for ${LANGUAGE} (${STDERR_LINTER_FILE_PATH}) doesn't exist"
fi
fi
feat: run linters in parallel (#5177)
2024-01-30 14:24:55 -05:00
CallStatusAPI "${LANGUAGE}" "error"
SUPER_LINTER_EXIT_CODE=1
debug "Setting super-linter exit code to ${SUPER_LINTER_EXIT_CODE} because there were errors for ${LANGUAGE}"
elif [[ ${ERROR_COUNTER} -eq 0 ]]; then
notice "Successfully linted ${LANGUAGE}"
Add management of FILTER_REGEX_INCLUDE and FILTER_REGEX_EXCLUDE options
2020-09-05 06:25:44 -04:00
CallStatusAPI "${LANGUAGE}" "success"
feat: run linters in parallel (#5177)
2024-01-30 14:24:55 -05:00
ANY_LINTER_SUCCESS="true"
debug "Set ANY_LINTER_SUCCESS to ${ANY_LINTER_SUCCESS} because ${LANGUAGE} reported a success"
Add management of FILTER_REGEX_INCLUDE and FILTER_REGEX_EXCLUDE options
2020-09-05 06:25:44 -04:00
fi
Cleanup footer prints
2020-04-27 15:13:12 -04:00
fi
done
feat: run linters in parallel (#5177)
2024-01-30 14:24:55 -05:00
if [[ "${ANY_LINTER_SUCCESS}" == "true" ]] && [[ ${SUPER_LINTER_EXIT_CODE} -ne 0 ]]; then
SUPER_LINTER_EXIT_CODE=2
debug "There was at least one linter that reported a success. Setting the super-linter exit code to: ${SUPER_LINTER_EXIT_CODE}"
fi
Variable braces
2020-07-21 13:09:07 -04:00
if [ "${DISABLE_ERRORS}" == "true" ]; then
feat: run linters in parallel (#5177)
2024-01-30 14:24:55 -05:00
warn "The super-linter exit code is ${SUPER_LINTER_EXIT_CODE}. Forcibly setting it to 0 because DISABLE_ERRORS is set to: ${DISABLE_ERRORS}"
SUPER_LINTER_EXIT_CODE=0
making cool moves
2020-07-22 15:49:26 -04:00
fi
feat: run linters in parallel (#5177)
2024-01-30 14:24:55 -05:00
if [[ ${SUPER_LINTER_EXIT_CODE} -eq 0 ]]; then
notice "All files and directories linted successfully"
else
error "Super-linter detected linting errors"
fi
making cool moves
2020-07-22 15:49:26 -04:00
feat: run linters in parallel (#5177)
2024-01-30 14:24:55 -05:00
exit ${SUPER_LINTER_EXIT_CODE}
initial commit
2019-10-21 10:12:50 -04:00
}
better... faster... stronger...
2020-08-24 15:12:37 -04:00
################################################################################
Image 4.0 (#1565) * adding new one... * adding automation * linter * pull apart for faster builds * maybe * update automation * fix that * prime is smart * fixed it * quotes * fix build image * inpec * typo * forgot backslash * fixed hairbrain logic * this should help cleanup * i hate r * order * maybe fix r * maybe fix r * update readme * remove spaces * update
2021-05-25 11:14:43 -04:00
#### Function UpdateLoopsForImage ##############################################
UpdateLoopsForImage() {
######################################################################
# Need to clean the array lists of the linters removed for the image #
######################################################################
if [[ "${IMAGE}" == "slim" ]]; then
#############################################
# Need to remove linters for the slim image #
#############################################
Update rustfmt with 2021 edition (#2196)
2021-12-07 12:18:34 -05:00
REMOVE_ARRAY=("ARM" "CSHARP" "ENV" "POWERSHELL" "RUST_2015" "RUST_2018"
"RUST_2021" "RUST_CLIPPY")
Image 4.0 (#1565) * adding new one... * adding automation * linter * pull apart for faster builds * maybe * update automation * fix that * prime is smart * fixed it * quotes * fix build image * inpec * typo * forgot backslash * fixed hairbrain logic * this should help cleanup * i hate r * order * maybe fix r * maybe fix r * update readme * remove spaces * update
2021-05-25 11:14:43 -04:00
# Remove from LANGUAGE_ARRAY
fix: simplify worker and linterVersions (#5123) - Remove the SKIP_FLAG variable and check for the length of the arrays of files to lint directly. - Remove the LIST_FILES variable, and use the FILE_ARRAY variable directly. - Remove the corner case for RENOVATE because renovate-config-validator supports passing the path to the file to lint using an argument as the default case does. - Remove the corner case for ANSIBLE not having 'bad' tests because it has them now. - Set TF_DATA_DIR to avoid any modification to any existing Terraform data directory that users might have in their workspace. - Aggregate GO_MODULES and ANSIBLE corner cases because they are the same. - Remove the corner case for ANSIBLE to add a trailing slash to TEST_CASE_FOLDER (similar reason as the previous point about ANSIBLE corner case). - Simplify log messages by removing color markers because they are already handled in log.sh. - Simplify linterVersions by removing redundant checks and functions. - Avoid printing debug logs in the versions file.
2024-01-15 13:37:45 -05:00
debug "Removing Languages from LANGUAGE_ARRAY for slim image..."
Image 4.0 (#1565) * adding new one... * adding automation * linter * pull apart for faster builds * maybe * update automation * fix that * prime is smart * fixed it * quotes * fix build image * inpec * typo * forgot backslash * fixed hairbrain logic * this should help cleanup * i hate r * order * maybe fix r * maybe fix r * update readme * remove spaces * update
2021-05-25 11:14:43 -04:00
for REMOVE_LANGUAGE in "${REMOVE_ARRAY[@]}"; do
for INDEX in "${!LANGUAGE_ARRAY[@]}"; do
if [[ ${LANGUAGE_ARRAY[INDEX]} = "${REMOVE_LANGUAGE}" ]]; then
fix: simplify worker and linterVersions (#5123) - Remove the SKIP_FLAG variable and check for the length of the arrays of files to lint directly. - Remove the LIST_FILES variable, and use the FILE_ARRAY variable directly. - Remove the corner case for RENOVATE because renovate-config-validator supports passing the path to the file to lint using an argument as the default case does. - Remove the corner case for ANSIBLE not having 'bad' tests because it has them now. - Set TF_DATA_DIR to avoid any modification to any existing Terraform data directory that users might have in their workspace. - Aggregate GO_MODULES and ANSIBLE corner cases because they are the same. - Remove the corner case for ANSIBLE to add a trailing slash to TEST_CASE_FOLDER (similar reason as the previous point about ANSIBLE corner case). - Simplify log messages by removing color markers because they are already handled in log.sh. - Simplify linterVersions by removing redundant checks and functions. - Avoid printing debug logs in the versions file.
2024-01-15 13:37:45 -05:00
debug "found item:[${REMOVE_LANGUAGE}], removing Language..."
Image 4.0 (#1565) * adding new one... * adding automation * linter * pull apart for faster builds * maybe * update automation * fix that * prime is smart * fixed it * quotes * fix build image * inpec * typo * forgot backslash * fixed hairbrain logic * this should help cleanup * i hate r * order * maybe fix r * maybe fix r * update readme * remove spaces * update
2021-05-25 11:14:43 -04:00
unset 'LANGUAGE_ARRAY[INDEX]'
fi
done
done
fi
}
Conditionally create log file
2023-01-05 08:32:46 -05:00
Fix shellcheck error Signed-off-by: Brett Logan <lindluni@github.com>
2023-01-04 01:17:47 -05:00
# shellcheck disable=SC2317
Add log functions
2020-07-27 17:11:33 -04:00
cleanup() {
Format (fix indentation)
2020-07-30 16:39:05 -04:00
local -ri EXIT_CODE=$?
feat: delete temporary files and directories (#5046) - Delete logback.log - Delete .lintr if super-linter created it
2024-01-10 04:06:04 -05:00
debug "Removing temporary files and directories"
feat: show error output when info is disabled (#5251) In case of linting errors, print stdout and stderr (if present) at the ERROR level if users set LOG_LEVEL to NOTICE to avoid failures without any explanation.
2024-02-10 04:16:31 -05:00
rm -rf \
feat: remove mypy cache (#5210) Remove MyPy cache after linting files so that users don't need to do as root.
2024-02-05 04:59:27 -05:00
"${GITHUB_WORKSPACE}/.mypy_cache" \
feat: delete temporary files and directories (#5046) - Delete logback.log - Delete .lintr if super-linter created it
2024-01-10 04:06:04 -05:00
"${GITHUB_WORKSPACE}/logback.log"
if [ "${SUPER_LINTER_COPIED_R_LINTER_RULES_FILE}" == "true" ]; then
debug "Deleting ${R_RULES_FILE_PATH_IN_ROOT} because super-linter created it."
feat: show error output when info is disabled (#5251) In case of linting errors, print stdout and stderr (if present) at the ERROR level if users set LOG_LEVEL to NOTICE to avoid failures without any explanation.
2024-02-10 04:16:31 -05:00
rm -rf "${R_RULES_FILE_PATH_IN_ROOT}"
feat: delete temporary files and directories (#5046) - Delete logback.log - Delete .lintr if super-linter created it
2024-01-10 04:06:04 -05:00
fi
Don't write colors and logs on disk if not necessary (#4934) * Don't write colors and logs on disk if not necessary * Set color markers * Fix colors * Fix linting errors * Fix linting errors * Use sudo to access logs
2023-12-05 03:04:13 -05:00
# Define this variable here so we can rely on it as soon as possible
Conditionally create log file
2023-01-05 08:32:46 -05:00
local LOG_FILE_PATH="${GITHUB_WORKSPACE}/${LOG_FILE}"
Don't write colors and logs on disk if not necessary (#4934) * Don't write colors and logs on disk if not necessary * Set color markers * Fix colors * Fix linting errors * Fix linting errors * Use sudo to access logs
2023-12-05 03:04:13 -05:00
debug "LOG_FILE_PATH: ${LOG_FILE_PATH}"
Conditionally create log file
2023-01-05 08:32:46 -05:00
if [ "${CREATE_LOG_FILE}" = "true" ]; then
Don't write colors and logs on disk if not necessary (#4934) * Don't write colors and logs on disk if not necessary * Set color markers * Fix colors * Fix linting errors * Fix linting errors * Use sudo to access logs
2023-12-05 03:04:13 -05:00
debug "Moving log file from ${LOG_TEMP} to ${LOG_FILE_PATH}"
mv \
--force \
"${LOG_TEMP}" "${LOG_FILE_PATH}"
Conditionally create log file
2023-01-05 08:32:46 -05:00
else
Don't write colors and logs on disk if not necessary (#4934) * Don't write colors and logs on disk if not necessary * Set color markers * Fix colors * Fix linting errors * Fix linting errors * Use sudo to access logs
2023-12-05 03:04:13 -05:00
debug "Skipping the moving of the log file from ${LOG_TEMP} to ${LOG_FILE_PATH}"
Conditionally create log file
2023-01-05 08:32:46 -05:00
fi
Add log functions
2020-07-27 17:11:33 -04:00
Fix shellcheck error Signed-off-by: Brett Logan <lindluni@github.com>
2023-01-04 01:17:47 -05:00
exit "${EXIT_CODE}"
Format (fix indentation)
2020-07-30 16:39:05 -04:00
trap - 0 1 2 3 6 14 15
initial commit
2019-10-21 10:12:50 -04:00
}
Add log functions
2020-07-27 17:11:33 -04:00
trap 'cleanup' 0 1 2 3 6 14 15
Conditionally create log file
2023-01-05 08:32:46 -05:00
initial commit
2019-10-21 10:12:50 -04:00
################################################################################
adding it
2019-10-21 12:05:55 -04:00
############################### MAIN ###########################################
initial commit
2019-10-21 10:12:50 -04:00
################################################################################
adding it
2019-10-21 12:05:55 -04:00
##########
# Header #
##########
Header
Image 4.0 (#1565) * adding new one... * adding automation * linter * pull apart for faster builds * maybe * update automation * fix that * prime is smart * fixed it * quotes * fix build image * inpec * typo * forgot backslash * fixed hairbrain logic * this should help cleanup * i hate r * order * maybe fix r * maybe fix r * update readme * remove spaces * update
2021-05-25 11:14:43 -04:00
################################################
# Need to update the loops for the image style #
################################################
UpdateLoopsForImage
build: move linter verions logic outside runtime (#5197) Move the logic to build the linter versions file outside the main runtime. There's no need to include it there because it's used only when building the image. Move the list of linters by name in linterVersions.sh because we don't need it in any other place.
2024-02-05 07:31:36 -05:00
if ! cat "${VERSION_FILE}"; then
fatal "Failed to view version file: ${VERSION_FILE}"
fi
Use the already-defined linter names array to print linter versions
2020-11-02 16:39:34 -05:00
cleaning
2019-10-21 15:12:37 -04:00
#######################
Minor brand wording change Rename Github to GitHub. Signed-off-by: Antoine Leblanc <ant.leblanc@gmail.com>
2020-06-19 01:44:26 -04:00
# Get GitHub Env Vars #
cleaning
2019-10-21 15:12:37 -04:00
#######################
Minor brand wording change Rename Github to GitHub. Signed-off-by: Antoine Leblanc <ant.leblanc@gmail.com>
2020-06-19 01:44:26 -04:00
# Need to pull in all the GitHub variables
cleaning
2019-10-21 15:12:37 -04:00
# needed to connect back and update checks
GetGitHubVars
Don't forcefully validate Git repos if not needed (#4953) * Fix find when linting non-git repos * Remove uses * Move safe.directory config after we set GITHUB_WORKSPACE * Fix Git validation check * Move 'find' test runner to makefile * Validate vars before validating Git repo * Validate Git repo even when VALIDATE_ALL_CODEBASE=false * Initialize GITHUB_SHA when running locally * Initialize safe git dirs * Check git safe dirs error code * Fix log level color marker * Fix linting errors * Fix change dir command * Fix linting errors * Set default branch
2023-12-07 14:07:22 -05:00
# Ensure that Git safe directories are configured because we don't do this in
# all cases when initializing variables
ConfigureGitSafeDirectories
fix: initialize GitHub domain variable (#5216) - Initialize GITHUB_DOMAIN as documented in the README - Configure other URLs according to GITHUB_DOMAIN - Automatically fetch SSH key fingerprints for GITHUB_DOMAINS
2024-02-09 13:45:44 -05:00
############################################
# Create SSH agent and add key if provided #
############################################
SetupSshAgent
SetupGithubComSshKeys
Lint with Kubeval and fixes
2020-09-21 18:53:30 -04:00
########################################################
# Initialize variables that depend on GitHub variables #
########################################################
Fix ts-standard configuration (#4932) * Fix ts-standard configuration * Fix default TYPESCRIPT_STANDARD_TSCONFIG_FILE assignment
2023-12-02 03:35:41 -05:00
TYPESCRIPT_STANDARD_TSCONFIG_FILE="${GITHUB_WORKSPACE}/${TYPESCRIPT_STANDARD_TSCONFIG_FILE:-"tsconfig.json"}"
debug "TYPESCRIPT_STANDARD_TSCONFIG_FILE: ${TYPESCRIPT_STANDARD_TSCONFIG_FILE}"
feat: delete temporary files and directories (#5046) - Delete logback.log - Delete .lintr if super-linter created it
2024-01-10 04:06:04 -05:00
R_RULES_FILE_PATH_IN_ROOT="${GITHUB_WORKSPACE}/${R_FILE_NAME}"
debug "R_RULES_FILE_PATH_IN_ROOT: ${R_RULES_FILE_PATH_IN_ROOT}"
Dynamically invoke linters
2020-10-08 18:54:28 -04:00
############################
# Validate the environment #
############################
Don't forcefully validate Git repos if not needed (#4953) * Fix find when linting non-git repos * Remove uses * Move safe.directory config after we set GITHUB_WORKSPACE * Fix Git validation check * Move 'find' test runner to makefile * Validate vars before validating Git repo * Validate Git repo even when VALIDATE_ALL_CODEBASE=false * Initialize GITHUB_SHA when running locally * Initialize safe git dirs * Check git safe dirs error code * Fix log level color marker * Fix linting errors * Fix change dir command * Fix linting errors * Set default branch
2023-12-07 14:07:22 -05:00
GetValidationInfo
Validate local git repo when ignoring files (#4965) Co-authored-by: Zack Koppert <zkoppert@github.com>
2023-12-18 13:31:06 -05:00
if [[ "${USE_FIND_ALGORITHM}" == "false" ]] || [[ "${IGNORE_GITIGNORED_FILES}" == "true" ]]; then
Exit on errors when running Git (#4889) * Exit on errors when running Git * Skip pulling changes entirely * Enable pipefail when generating diffs * Cleanup * Shallow repo check * Echo GITHUB_SHA update * Check if GITHUB_SHA exists before using it * Move GITHUB_SHA validation to validation script * Rely on cat-file return code * Check if DEFAULT_BRANCH exists * Change dir when checking DEFAULT_BRANCH * Show git branches * Don't switch branches * Check GITHUB_SHA only when needed * Ensure we have permissions before interacting with the repo * Remove the DIFF_CMD variable * Move TEST_CASE_RUN and RUN_LOCAL init up * Validate if Git repo and if SHA exists * Move validation function * Change dir when getting branch names * Move debug messages up to be less verbose * Move branch validation in a function * Fix linting errors
2023-12-04 04:47:49 -05:00
debug "Validate the local Git environment"
ValidateLocalGitRepository
ValidateGitShaReference
ValidateDefaultGitBranch
else
debug "Skipped the validation of the local Git environment because we don't depend on it."
fi
feat!: run linters against the workspace (#5041) - Run jscpd, gitleaks, textlint against the entire workspace instead of running them over single files, one by one. - Implement a warning function for deprecated variables. - Deprecate the VALIDATE_JSCPD_ALL_CODEBASE variable. - Remove duplicate configuration files when they are the same as the ones we provide in TEMPLATES. - Add a missing tests for ansible-lint. - Move ANSIBLE_DIRECTORY configuration when running tests in buildFileList, where similar configs are. - Simplify ansible-lint test cases to include only what's necessary, and not an entire set of roles, playbooks, and inventory. - Write instructions about major upgrades in the upgrade guide.
2023-12-24 11:56:15 -05:00
ValidateDeprecatedVariables
LINTER_RULE_PATH fix (#1649) * adding root code * removbe a typio
2021-06-10 14:09:24 -04:00
#################################
# Get the linter rules location #
#################################
LinterRulesLocation
adding it
2019-10-21 12:05:55 -04:00
########################
# Get the linter rules #
########################
Use ts-standard instead of standard as TYPESCRIPT_STANDARD (#2614) * Use ts-standard instead of standard as TYPESCRIPT_STANDARD * Add ts-standard * Update test case * Update test case * Add tsconfig.json * Add tsconfig.json environment value * Fix "TypeScript" * Fix package version * Fix package version * Fix package version * Fix package version * Fix settings * Remove config file env * Fix version * Fix eslintrc * Fix project path * Fix project path * Fix setting * Fix env * Add .eslintrc.yml for ts-standard * Fix README * Fix settings * Change include paths * Change include paths * Change include paths * Change include paths * Fix dependencies * Fix dependencies * Fix dependence versions
2022-03-16 11:21:57 -04:00
LANGUAGE_ARRAY_FOR_LINTER_RULES=("${LANGUAGE_ARRAY[@]}" "TYPESCRIPT_STANDARD_TSCONFIG")
for LANGUAGE in "${LANGUAGE_ARRAY_FOR_LINTER_RULES[@]}"; do
Dynamically load linter rules
2020-10-03 17:01:07 -04:00
debug "Loading rules for ${LANGUAGE}..."
Simplify rules files loading, plus fixes
2020-10-15 05:43:56 -04:00
eval "GetLinterRules ${LANGUAGE} ${DEFAULT_RULES_LOCATION}"
Dynamically load linter rules
2020-10-03 17:01:07 -04:00
done
major rewrite
2020-02-03 11:27:40 -05:00
Fix ts-standard configuration (#4932) * Fix ts-standard configuration * Fix default TYPESCRIPT_STANDARD_TSCONFIG_FILE assignment
2023-12-02 03:35:41 -05:00
# Load rules for special cases
Dynamically invoke linters
2020-10-08 18:54:28 -04:00
GetStandardRules "javascript"
Certs (#1470) * adding cert * update readme * typo * make exec * spaces * adding better way * adding example * make shell happy * fix space * adding notes * bad var * duh
2021-04-26 10:00:42 -04:00
#################################
# Check for SSL cert and update #
#################################
CheckSSLCert
Centralize file list building logic in buildFileList.sh
2020-10-03 06:55:34 -04:00
###########################################
# Build the list of files for each linter #
###########################################
feat!: run linters against the workspace (#5041) - Run jscpd, gitleaks, textlint against the entire workspace instead of running them over single files, one by one. - Implement a warning function for deprecated variables. - Deprecate the VALIDATE_JSCPD_ALL_CODEBASE variable. - Remove duplicate configuration files when they are the same as the ones we provide in TEMPLATES. - Add a missing tests for ansible-lint. - Move ANSIBLE_DIRECTORY configuration when running tests in buildFileList, where similar configs are. - Simplify ansible-lint test cases to include only what's necessary, and not an entire set of roles, playbooks, and inventory. - Write instructions about major upgrades in the upgrade guide.
2023-12-24 11:56:15 -05:00
BuildFileList "${VALIDATE_ALL_CODEBASE}" "${TEST_CASE_RUN}"
cleaning
2019-10-21 15:12:37 -04:00
adding composer code (#1950) * adding composer code * making it better * adding composer bin * adding some logic * make shellfmt happy
2021-09-10 10:43:20 -04:00
#####################################
# Run additional Installs as needed #
#####################################
RunAdditionalInstalls
Print environment variables before running linters
2020-10-15 07:07:01 -04:00
####################################
# Print ENV before running linters #
####################################
debug "--- ENV (before running linters) ---"
debug "------------------------------------"
debug "ENV:"
feat: run linters in parallel (#5177)
2024-01-30 14:24:55 -05:00
debug "$(printenv)"
Print environment variables before running linters
2020-10-15 07:07:01 -04:00
debug "------------------------------------"
Print environment variables before running linters
2020-10-15 06:38:38 -04:00
Group log output on GitHub Actions (#4961)
2023-12-12 14:57:15 -05:00
endGitHubActionsLogGroup "${SUPER_LINTER_INITIALIZATION_LOG_GROUP_TITLE}"
feat: run linters in parallel (#5177)
2024-01-30 14:24:55 -05:00
###############
# Run linters #
###############
declare PARALLEL_RESULTS_FILE_PATH
PARALLEL_RESULTS_FILE_PATH="/tmp/super-linter-results.json"
debug "PARALLEL_RESULTS_FILE_PATH: ${PARALLEL_RESULTS_FILE_PATH}"
Add support for OpenAPI
2020-06-25 02:13:19 -04:00
feat: run linters in parallel (#5177)
2024-01-30 14:24:55 -05:00
declare -a PARALLEL_COMMAND
PARALLEL_COMMAND=(parallel --will-cite --keep-order --max-procs "$(($(nproc) * 1))" --xargs --results "${PARALLEL_RESULTS_FILE_PATH}")
add .lintr detection
2020-08-17 08:01:25 -04:00
feat: run linters in parallel (#5177)
2024-01-30 14:24:55 -05:00
# Run one LANGUAGE per process. Each of these processes will run more processees in parellel if supported
PARALLEL_COMMAND+=(--max-lines 1)
add R with edgecases
2020-08-15 15:29:22 -04:00
feat: run linters in parallel (#5177)
2024-01-30 14:24:55 -05:00
if [ "${LOG_DEBUG}" == "true" ]; then
debug "LOG_DEBUG is enabled. Enable verbose ouput for parallel"
PARALLEL_COMMAND+=(--verbose)
fi
Add support for OpenAPI
2020-06-25 02:13:19 -04:00
feat: run linters in parallel (#5177)
2024-01-30 14:24:55 -05:00
PARALLEL_COMMAND+=("LintCodebase" "{}" "\"${TEST_CASE_RUN}\"")
debug "PARALLEL_COMMAND: ${PARALLEL_COMMAND[*]}"
Add HTML support to super-linter
2020-07-04 18:14:27 -04:00
feat: run linters in parallel (#5177)
2024-01-30 14:24:55 -05:00
PARALLEL_COMMAND_OUTPUT=$(printf "%s\n" "${LANGUAGE_ARRAY[@]}" | "${PARALLEL_COMMAND[@]}" 2>&1)
PARALLEL_COMMAND_RETURN_CODE=$?
debug "PARALLEL_COMMAND_OUTPUT when running linters (exit code: ${PARALLEL_COMMAND_RETURN_CODE}):\n${PARALLEL_COMMAND_OUTPUT}"
debug "Parallel output file (${PARALLEL_RESULTS_FILE_PATH}) contents when running linters:\n$(cat "${PARALLEL_RESULTS_FILE_PATH}")"
RESULTS_OBJECT=
fix: don't add unnecessary empty lines (#5221)
2024-02-05 05:49:22 -05:00
if ! RESULTS_OBJECT=$(jq --raw-output -n '[inputs]' "${PARALLEL_RESULTS_FILE_PATH}"); then
feat: run linters in parallel (#5177)
2024-01-30 14:24:55 -05:00
fatal "Error loading results when building the file list: ${RESULTS_OBJECT}"
fi
debug "RESULTS_OBJECT when running linters:\n${RESULTS_OBJECT}"
fix: don't add unnecessary empty lines (#5221)
2024-02-05 05:49:22 -05:00
# Get raw output so we can strip quotes from the data we load. Also, strip the final newline to avoid adding it two times
fix: don't print empty lines with default logging (#5238) - Check if Stdout and Stderr have elements before printing them. - Run the super-linter action in a dedicated step using default logging to inspect how the output looks during CI.
2024-02-05 12:24:07 -05:00
if ! STDOUT_LINTERS="$(jq --raw-output '.[] | select(.Stdout[:-1] | length > 0) | .Stdout[:-1]' <<<"${RESULTS_OBJECT}")"; then
feat: run linters in parallel (#5177)
2024-01-30 14:24:55 -05:00
fatal "Error when loading stdout when running linters:\n${STDOUT_LINTERS}"
fi
if [ -n "${STDOUT_LINTERS}" ]; then
info "Command output when running linters:\n------\n${STDOUT_LINTERS}\n------"
else
debug "Stdout when running linters is empty"
fi
fix: don't print empty lines with default logging (#5238) - Check if Stdout and Stderr have elements before printing them. - Run the super-linter action in a dedicated step using default logging to inspect how the output looks during CI.
2024-02-05 12:24:07 -05:00
if ! STDERR_LINTERS="$(jq --raw-output '.[] | select(.Stderr[:-1] | length > 0) | .Stderr[:-1]' <<<"${RESULTS_OBJECT}")"; then
feat: run linters in parallel (#5177)
2024-01-30 14:24:55 -05:00
fatal "Error when loading stderr for ${FILE_TYPE}:\n${STDERR_LINTERS}"
fi
if [ -n "${STDERR_LINTERS}" ]; then
fix: don't add unnecessary empty lines (#5221)
2024-02-05 05:49:22 -05:00
info "Stderr when running linters:\n------\n${STDERR_LINTERS}\n------"
feat: run linters in parallel (#5177)
2024-01-30 14:24:55 -05:00
else
debug "Stderr when running linters is empty"
fi
if [[ ${PARALLEL_COMMAND_RETURN_CODE} -ne 0 ]]; then
fatal "Error when running linters. Exit code: ${PARALLEL_COMMAND_RETURN_CODE}"
fi
Adding it
2020-07-23 13:52:43 -04:00
adding it
2019-10-21 12:05:55 -04:00
##########
# Footer #
##########
Footer
Reference in a new issue Copy permalink