Meta tags:
description=Combination of multiple linters to install as a GitHub Action - github/super-linter;

Headings (most frequently used words):

github, super, linter, files, launching, how, your, rules, readme, to, use, contribute, action, visual, studio, license, with, desktop, cookies, latest, commit, git, stats, md, table, of, contents, it, works, supported, linters, environment, variables, filter, linted, docker, hub, run, outside, actions, limitations, about, releases, 41, packages, contributors, 110, languages, join, today, is, where, the, world, builds, software, example, connecting, workflow, add, badge, in, repository, template, using, own, disabling, local, troubleshooting, debugging, enhancements, azure, gitlab, code, topics, resources, learn, connect, others, xcode, this, project, essential, always, active, analytics,

Text of the page (most frequently used words):
the (191), #github (70), true (66), linting (65), flag (62), disable (61), enable (60), process (60), language (55), linter (50), for (36), you (33), lint (33), super (31), and (29), files (25), 2020 (24), code (24), your (23), this (22), repository (20), will (19), utilizing (19), action (17), nov (17), yml (17), rules (16), use (15), with (15), all (15), configuration (15), linters (14), actions (13), are (13), run (13), filename (13), how (12), can (12), from (12), file (11), php (11), set (11), more (10), not (10), com (9), python (9), base (9), editorconfig (9), false (9), name (9), that (8), license (8), only (8), eslint (8), output (8), log (7), security (7), readme (7), check (7), json (7), using (7), folder (7), yaml (7), ansible (7), master (7), variables (7), https (7), pull (7), fix (7), cookies (6), about (6), need (6), learn (6), build (6), out (6), help (6), status (6), change (6), debug (6), test (6), level (6), isort (6), eslintrc (6), checker (6), errors (6), default (6), workflow (6), javascript (5), languages (5), latest (5), checkout (5), visual (5), note (5), docker (5), own (5), have (5), template (5), back (5), any (5), try (5), flake8 (5), env (5), bash (5), new (5), toml (5), supported (5), format (5), one (5), warn (5), workflows (5), badge (5), git (5), commit (5), download (5), desktop (5), sign (5), analytics (4), understand (4), they (4), information (4), see (4), shell (4), mit (4), combination (4), multiple (4), contribute (4), additional (4), studio (4), locally (4), works (4), built (4), filter_regex_exclude (4), src (4), environment (4), location (4), standard (4), issues (4), snakefmt (4), snakemake (4), ruby (4), pylint (4), black (4), markdown (4), gherkin (4), validate (4), report (4), markdownlint (4), branch (4), following (4), marketplace (4), example (4), add (4), github_token (4), request (4), open (4), move (4), nothing (4), happens (4), again (4), launching (4), jump (4), preferences (3), our (3), them (3), better (3), essential (3), update (3), optional (3), time (3), html (3), dockerfile (3), install (3), dependencies (3), fail (3), being (3), below (3), list (3), limitations (3), development (3), azure (3), documentation (3), local (3), outside (3), filter_regex_include (3), exclude (3), linted (3), view (3), directory (3), where (3), their (3), templates (3), each (3), should (3), yamllint (3), typescript (3), terragrunt (3), terraform (3), tekton (3), sql (3), aws (3), raku (3), kubeval (3), executable (3), arm (3), when (3), pyproject (3), rubocop (3), cfg (3), none (3), console (3), which (3), hadolint (3), stylelintrc (3), but (3), full (3), there (3), variable (3), groovy (3), job (3), branches (3), ignore (3), wiki (3), developers (3), requests (3), commits (3), dockerignore (3), 1034 (3), web (3), software (3), projects (3), reject (2), accept (2), make (2), used (2), task (2), always (2), perform (2), third (2), party (2), products (2), privacy (2), cookie (2), signed (2), another (2), tab (2), window (2), refresh (2), session (2), reload (2), api (2), pricing (2), contact (2), contributors (2), packages (2), releases (2), topics (2), please (2), due (2), details (2), read (2), able (2), versions (2), available (2), container (2), gitlab (2), continuous (2), integration (2), find (2), follow (2), running (2), troubleshooting (2), debugging (2), enhancements (2), located (2), hub (2), inside (2), some (2), filter (2), functionality (2), disabling (2), what (2), copy (2), into (2), allows (2), individual (2), without (2), xml (2), snakefiles (2), shfmt (2), powershell (2), keep (2), backward (2), compatibility (2), psalm (2), phpstan (2), codesniffer (2), perl (2), openapi (2), latex (2), kotlin (2), golang (2), dart (2), css (2), coffeescript (2), clojure (2), across (2), validate_all_codebase (2), formats (2), simpler (2), generated (2), tap (2), currently (2), script (2), verbose (2), error (2), log_level (2), regular (2), expression (2), defining (2), exec (2), complete (2), default_workspace (2), default_branch (2), stylelint (2), specific (2), validate_ (2), leaving (2), unset (2), those (2), passed (2), then (2), pass (2), npm (2), 20code (2), 20base (2), svg (2), show (2), secrets (2), uses (2), depth (2), get (2), steps (2), load (2), push (2), connecting (2), automatically (2), working (2), create (2), pushed (2), best (2), suggested (2), failed (2), table (2), contents (2), source (2), apr (2), typo (2), 1037 (2), pipfile (2), sep (2), symlink (2), 982 (2), harden (2), testing (2), message (2), cf0e6a9 (2), admiralawkbar (2), xcode (2), cli (2), project (2), dismiss (2), world (2), together (2), review (2), insights (2), watch (2), star (2), 400 (2), stars (2), education (2), plans (2), explore (2), team (2), management (2), save, websites, gather, pages, visit, many, clicks, accomplish, active, website, functions, selection, clicking, bottom, page, statement, blog, training, terms, inc, other, tex, 110, resources, hacktoberfest, quality, would, like, contributing, downloading, codebases, private, repositories, lack, permissions, package, completely, packaged, enclosed, binaries, known, also, support, once, becomes, codespaces, remote, snippet, article, versus, via, examples, parameters, certain, contains, live, tell, names, does, fall, defaults, personal, sets, greater, flexibility, standards, believe, enabled, basic, yaml_config_file, validate_yaml, validate_xml, validate_typescript_standard, validate_typescript_es, tsx, validate_tsx, validate_terragrunt, related, validate_terraform_terrascan, validate_terraform, validate_tekton, validate_sql, states, validate_states, validate_snakemake_snakefmt, validate_snakemake_lint, scripts, validate_shell_shfmt, validate_ruby, validate_raku, validate_r, validate_powershell, validate_python_pylint, validate_python_isort, validate_python_flake8, validate_python_black, validate_python, protobuf, validate_protobuf, validate_php_psalm, validate_php_phpstan, validate_php_phpcs, validate_php_builtin, validate_php, validate_perl, validate_openapi, validate_markdown, validate_lua, validate_latex, kubernetes, descriptors, validate_kubernetes_kubeval, validate_kotlin, jsx, validate_jsx, validate_json, validate_javascript_standard, validate_javascript_es, validate_java, validate_html, validate_groovy, validate_go, validate_gherkin, validate_env, validate_editorconfig, validate_dockerfile_hadolint, validate_dockerfile, validate_dart, validate_css, validate_csharp, validate_coffee, cloud, formation, validate_cloudformation, validate_clojure, stored, validate_bash_exec, validate_bash, validate_arm, validate_ansible, parse, entire, types, parsed, validation, edited, typescript_es_config_file, snakemake_snakefmt_config_file, ruby_config_file, pylintrc, python_pylint_config_file, python_isort_config_file, tox, ini, python_flake8_config_file, python_black_config_file, reported, detailed, output_details, reporting, must, previously, exist, output_folder, besides, stdout, v13, specification, output_format, markdown_config_file, made, parsing, easier, multi_status, much, generate, trace, notice, outputting, logs, sent, regardless, log_file, linter_rules_path, javascript_es_config_file, processed, excluded, warning, instead, error_on_missing_exec_bit, ecrc, editorconfig_file_name, hadolintlintrc, dockerfile_hadolint_file_name, exit, even, were, detected, disable_errors, containing, tmp, css_file_name, root, relative, ansible_directory, actions_runner_debug, notes, value, var, means, box, checked, wish, select, give, control, choose, won, anything, unexpected, both, behave, very, way, trigger, different, did, badges, nvuillam, owner, against, fetch, history, needed, proper, changed, within, ubuntu, runs, agent, jobs, pull_request, remove, line, above, pushing, start, articles, syntax, similar, mark, checks, section, overall, secret, needs, customization, options, enjoy, cleaner, stable, observe, extra, required, called, tutorial, libxml, terrascan, tflint, bit, shellcheck, lintr, python3, protolint, protocol, buffers, psscriptanalyzer, perlcritic, spectral, luacheck, lua, chktex, ktlint, jsonlint, checkstyle, java, htmlhint, golangci, dotenv, dockerfilelint, dartanalyzer, coffeelint, clj, kondo, dotnet, cfn, cloudformation, ttk, resource, manager, call, design, allow, occur, part, occurring, early, often, draft, desire, closer, faster, feedback, yet, finds, reports, fixes, fixed, automate, streamline, reviews, guidelines, layout, establish, coding, practices, prevent, broken, uploaded, main, usually, end, goal, tool, simple, various, written, header, 1023, code_of_conduct, gitignore, gitattributes, oct, merge, testcodebase, lintcodebase, eslintignore, formatting, lib, 1000, docs, 1011, vscode, 1036, codeowners, devcontainer, automation, type, permalink, 102, stats, printed, found, authored, lukas, gravley, gabofdc, extension, zip, work, fast, official, svn, url, clone, tags, existing, free, millions, companies, ship, maintain, largest, most, advanced, platform, builds, home, over, million, host, manage, join, today, forks, fork, 176, results, nonprofit, sales, compare, program, community, forum, events, connect, others, guides, learning, lab, trending, collections, enterprise, customer, stories, mobile, hosting, integrations, features, why, skip, content, wayback, machine, http, archive, org, 20201203033944, timestamps, capture, success, 2021, 2019, jan, dec, may, aug, 2026, 661, captures,

Text of the page (random words):
b github super linter combination of multiple linters to install as a github action 661 captures 05 may 2020 20 aug 2026 nov dec jan 03 2019 2020 2021 success fail about this capture timestamps the wayback machine http web archive org web 20201203033944 https github com github super linter skip to content sign up why github features code review project management integrations actions packages security team management hosting mobile customer stories security team enterprise explore explore github learn contribute topics collections trending learning lab open source guides connect with others events community forum github education github stars program marketplace pricing plans compare plans contact sales nonprofit education in this repository all github jump to no suggested jump to results in this repository all github jump to in this repository all github jump to sign in sign up message github super linter watch 176 star 6k fork 400 combination of multiple linters to install as a github action mit license 6k stars 400 forks star watch code issues 33 pull requests 5 actions projects 1 wiki security insights more code issues pull requests actions projects wiki security insights dismiss join github today github is home to over 50 million developers working together to host and review code manage projects and build software together sign up github is where the world builds software millions of developers and companies build ship and maintain their software on github the largest and most advanced development platform in the world sign up for free dismiss use this github action with your project add this action to an existing workflow or create a new one view on marketplace master 11 branches 41 tags go to file code clone https github cli use git or checkout with svn using the web url work fast with our official cli learn more open with github desktop download zip launching github desktop if nothing happens download github desktop and try again go back launching github desktop if nothing happens download github desktop and try again go back launching xcode if nothing happens download xcode and try again go back launching visual studio if nothing happens download the github extension for visual studio and try again go back latest commit gabofdc and admiralawkbar change log level from warn to debug 1034 cf0e6a9 nov 30 2020 change log level from warn to debug 1034 change log level from warn to debug move linting x file to be printed only if files are found co authored by lukas gravley admiralawkbar github com cf0e6a9 git stats 2 102 commits files permalink failed to load latest commit information type name latest commit message commit time automation harden testing 982 nov 20 2020 devcontainer fix editorconfig checker errors nov 5 2020 github update codeowners 1036 nov 30 2020 vscode harden testing 982 nov 20 2020 templates gherkin 1011 nov 19 2020 dependencies move ansible lint to pipfile 1037 nov 30 2020 docs fix typo 1000 nov 16 2020 lib change log level from warn to debug 1034 nov 30 2020 dockerignore ignore git and symlink dockerignore sep 25 2020 editorconfig fix go formatting nov 6 2020 eslintignore merge testcodebase and lintcodebase oct 17 2020 gitattributes fix editorconfig checker errors nov 5 2020 gitignore ignore git and symlink dockerignore sep 25 2020 code_of_conduct md fix editorconfig checker errors nov 5 2020 dockerfile move ansible lint to pipfile 1037 nov 30 2020 license change to mit license apr 28 2020 readme md fix typo in readme md 1023 nov 23 2020 security md add header apr 28 2020 action yml fix editorconfig checker errors nov 5 2020 view code readme md super linter this repository is for the github action to run a super linter it is a simple combination of various linters written in bash to help validate your source code the end goal of this tool prevent broken code from being uploaded to the default branch usually master or main help establish coding best practices across multiple languages build guidelines for code layout and format automate the process to help streamline code reviews table of contents super linter table of contents how it works supported linters how to use example connecting github action workflow add super linter badge in your repository readme environment variables template rules files using your own rules files disabling rules filter linted files docker hub run super linter outside github actions local troubleshooting debugging enhancements azure gitlab visual studio code limitations how to contribute license how it works the super linter finds issues and reports them to the console output fixes are suggested in the console output but not automatically fixed and a status check will show up as failed on the pull request the design of the super linter is currently to allow linting to occur in github actions as a part of continuous integration occurring on pull requests as the commits get pushed it works best when commits are being pushed early and often to a branch with an open or draft pull request there is some desire to move this closer to local development for faster feedback on linting errors but this is not yet supported supported linters developers on github can call the github action to lint their code base with the following list of linters language linter ansible ansible lint azure resource manager arm arm ttk aws cloudformation templates cfn lint c dotnet format css stylelint clojure clj kondo coffeescript coffeelint dart dartanalyzer dockerfile dockerfilelint hadolint editorconfig editorconfig checker env dotenv linter gherkin gherkin lint golang golangci lint groovy npm groovy lint html htmlhint java checkstyle javascript eslint standard js json jsonlint kubeval kubeval kotlin ktlint latex chktex lua luacheck markdown markdownlint openapi spectral perl perlcritic php php built in linter php codesniffer phpstan psalm powershell psscriptanalyzer protocol buffers protolint python3 pylint flake8 black isort r lintr raku raku ruby rubocop shell shellcheck executable bit check shfmt snakemake snakefmt snakemake lint sql sql lint tekton tekton lint terraform tflint terrascan terragrunt terragrunt typescript eslint standard js xml libxml yaml yamllint how to use more in depth tutorial available to use this github action you will need to complete the following create a new file in your repository called github workflows linter yml copy the example workflow from below into that new file no extra configuration required commit that file to a new branch open up a pull request and observe the action working enjoy your more stable and cleaner code base check out the wiki for customization options note if you pass the environment variable github_token secrets github_token in your workflow then the github super linter will mark the status of each individual linter run in the checks section of a pull request without this you will only see the overall status of the full run there is no need to set the github secret as it is automatically set by github it only needs to be passed to the action example connecting github action workflow in your repository you should have a github workflows folder with github action similar to below github workflows linter yml this file should have the following code linter github actions name lint code base documentation https help github com en articles workflow syntax for github actions start the job on all push on push branches ignore master remove the line above to run when pushing to master pull_request branches master set the job jobs build name the job name lint code base set the agent to run on runs on ubuntu latest load all steps steps checkout the code base name checkout code uses actions checkout v2 with full git history is needed to get a proper list of changed files within super linter fetch depth 0 run linter against code base name lint code base uses github super linter v3 env validate_all_codebase false default_branch master github_token secrets github_token add super linter badge in your repository readme you can show super linter status with a badge in your repository readme format github super linter https github com owner repository workflows lint 20code 20base badge svg https github com marketplace actions super linter example github super linter https github com nvuillam npm groovy lint workflows lint 20code 20base badge svg https github com marketplace actions super linter note if you did not use lint code base as github action name please read github actions badges documentation environment variables the super linter allows you to pass the following env variables to be able to trigger different functionality note all the validate_ language variables behave in a very specific way if none of them are passed then they all default to true if any one of the variables are set to true we default to leaving any unset variable to false only validate those languages if any one of the variables are set to false we default to leaving any unset variable to true only exclude those languages if there are validate_ language variables set to both true and false it will fail this means that if you run the linter out of the box all languages will be checked but if you wish to select or exclude specific linters we give you full control to choose which linters are run and won t run anything unexpected env var default value notes actions_runner_debug false flag to enable additional information about the linter versions and additional output ansible_directory ansible flag to set the root directory for ansible file location s relative to default_workspace css_file_name stylelintrc json filename for stylelint configuration ex stylelintrc yml stylelintrc yaml default_branch master the name of the repository default branch default_workspace tmp lint the location containing files to lint if you are running locally disable_errors false flag to have the linter complete with exit code 0 even if errors were detected dockerfile_hadolint_file_name hadolint yml filename for hadolint configuration ex hadolintlintrc yaml editorconfig_file_name ecrc filename for editorconfig checker configuration error_on_missing_exec_bit false if set to false the bash exec linter will report a warning if a shell script is not executable if set to true the bash exec linter will report an error instead filter_regex_exclude none regular expression defining which files will be excluded from linting ex src test filter_regex_include all regular expression defining which files will be processed by linters ex src javascript_es_config_file eslintrc yml filename for eslint configuration ex eslintrc yml eslintrc json linter_rules_path github linters directory for all linter configuration rules log_file super linter log the file name for outputting logs all output is sent to the log file regardless of log_level log_level verbose how much output the script will generate to the console one of error warn notice verbose debug or trace multi_status true a status api is made for each language that is linted to make visual parsing easier markdown_config_file markdown lint yml filename for markdownlint configuration ex markdown lint yml markdownlint json markdownlint yaml output_format none the report format to be generated besides the stdout one output format of tap is currently using v13 of the specification supported formats tap output_folder super linter report the location where the output reporting will be generated to output folder must not previously exist output_details simpler what level of details to be reported supported formats simpler or detailed python_black_config_file python black filename for black configuration ex isort cfg pyproject toml python_flake8_config_file flake8 filename for flake8 configuration ex flake8 tox ini python_isort_config_file isort cfg filename for isort configuration ex isort cfg pyproject toml python_pylint_config_file python lint filename for pylint configuration ex python lint pylintrc ruby_config_file ruby lint yml filename for rubocop configuration ex ruby lint yml rubocop yml snakemake_snakefmt_config_file snakefmt toml filename for snakemake configuration ex pyproject toml snakefmt toml typescript_es_config_file eslintrc yml filename for eslint configuration ex eslintrc yml eslintrc json validate_all_codebase true will parse the entire repository and find all files to validate across all types note when set to false only new or edited files will be parsed for validation validate_ansible true flag to enable or disable the linting process of the ansible language validate_arm true flag to enable or disable the linting process of the arm language validate_bash true flag to enable or disable the linting process of the bash language validate_bash_exec true flag to enable or disable the linting process of the bash language to validate if file is stored as executable validate_clojure true flag to enable or disable the linting process of the clojure language validate_cloudformation true flag to enable or disable the linting process of the aws cloud formation language validate_coffee true flag to enable or disable the linting process of the coffeescript language validate_csharp true flag to enable or disable the linting process of the c language validate_css true flag to enable or disable the linting process of the css language validate_dart true flag to enable or disable the linting process of the dart language validate_dockerfile true flag to enable or disable the linting process of the docker language validate_dockerfile_hadolint true flag to enable or disable the linting process of the docker language validate_editorconfig true flag to enable or disable the linting process with the editorconfig validate_env true flag to enable or disable the linting process of the env language validate_gherkin true flag to enable or disable the linting process of the gherkin language validate_go true flag to enable or disable the linting process of the golang language validate_groovy true flag to enable or disable the linting process of the language validate_html true flag to enable or disable the linting process of the html language validate_java true flag to enable or disable the linting process of the language validate_javascript_es true flag to enable or disable the linting process of the javascript language utilizing eslint validate_javascript_standard true flag to enable or disable the linting process of the javascript language utilizing standard validate_json true flag to enable or disable the linting process of the json language validate_jsx true flag to enable or disable the linting process for jsx files utilizing eslint validate_kotlin true flag to enable or disable the linting process of the kotlin language validate_kubernetes_kubeval true flag to enable or disable the linting process of kubernetes descriptors with kubeval validate_latex true flag to enable or disable the linting process of the latex language validate_lua true flag to enable or disable the lintin...