MegaLinter ist ein Open-Source- Tool für CI/CD-Workflows , das die Konsistenz Ihres Codes , IAC , Konfiguration und Skripts in Ihren Repository-Quellen analysiert, um sicherzustellen, dass alle Ihre Projektquellen sauber und formatiert sind, unabhängig davon, welche IDE/Toolbox von ihren Entwicklern verwendet wird , unterstützt von OX Security .
Unterstützt 62 Sprachen, 23 Formate, 20 Tooling-Formate und ist sofort einsatzbereit , als GitHub-Aktion oder jedes CI-System, hochgradig konfigurierbar und für alle Zwecke kostenlos .
MegaLinter verfügt über native Integrationen mit vielen der wichtigsten CI/CD-Tools auf dem Markt.
Upgrade auf MegaLinter v8 :)
Bevor Sie weiter unten fortfahren, sehen Sie sich die Website zur Online-Dokumentation an, die eine viel einfachere Benutzerführung bietet als diese README-Datei
Projekte müssen sauberen Code enthalten, um technische Schulden zu vermeiden , die die evolutive Wartung schwieriger und zeitaufwändiger machen.
Durch die Verwendung von Codeformatierern und Code-Linters stellen Sie sicher, dass Ihre Codebasis leichter lesbar ist und Best Practices berücksichtigt , vom Start bis zu jedem Schritt des Projektlebenszyklus
Nicht alle Entwickler haben die gute Angewohnheit, Linters in ihren IDEs zu verwenden, was die Codeüberprüfung schwieriger und länger zu verarbeiten macht
Durch die Nutzung von MegaLinter profitieren Sie und Ihr Team von folgenden Vorteilen:
npx mega-linter-runner --install
aus, um Konfigurationsdateien zu generieren (Sie müssen node.js installieren)Hinweise :
super-linter/super-linter@v3
durch oxsecurity/megalinter@v8
in Ihrer GitHub Action YML-Datei, wie in dieser PR).Alle Linters sind in das MegaLinter-Docker-Image integriert, das regelmäßig mit den neuesten Versionen aktualisiert wird
Sprache | Linter | Zusätzlich | |
---|---|---|---|
BASH | bash-exec BASH_EXEC | ||
BASH | Shellcheck BASH_SHELLCHECK | ||
BASH | shfmt BASH_SHFMT | ||
C | cpplint C_CPPLINT | ||
C | Clang-Format C_CLANG_FORMAT | ||
CLOJURE | clj-kondo CLOJURE_CLJ_KONDO | ||
CLOJURE | cljstyle CLOJURE_CLJSTYLE | ||
KAFFEE | Kaffeelint COFFEE_COFFEELINT | ||
C++ (CPP) | cpplint CPP_CPPLINT | ||
C++ (CPP) | Clang-Format CPP_CLANG_FORMAT | ||
C# (CSHARP) | Dotnet-Format CSHARP_DOTNET_FORMAT | ||
C# (CSHARP) | schärfer CSHARP_CSHARPIER | ||
C# (CSHARP) | Roslynator CSHARP_ROSLYNATOR | ||
PFEIL | Dartanalysator DART_DARTANALYZER | ||
GEHEN | golangci-lint GO_GOLANGCI_LINT | ||
GEHEN | beleben GO_REVIVE | ||
GROOVIG | npm-groovy-lint GROOVY_NPM_GROOVY_LINT | ||
JAVA | Karostil JAVA_CHECKSTYLE | ||
JAVA | pmd JAVA_PMD | ||
JAVASCRIPT | eslint JAVASCRIPT_ES | ||
JAVASCRIPT | Standard JAVASCRIPT_STANDARD | ||
JAVASCRIPT | hübscher JAVASCRIPT_PRETTIER | ||
JSX | eslint JSX_ESLINT | ||
KOTLIN | ktlint KOTLIN_KTLINT | ||
KOTLIN | detekt KOTLIN_DETEKT | ||
LUA | luacheck LUA_LUACHECK | ||
LUA | Selen LUA_SELENE | ||
LUA | Stift LUA_STYLUA | ||
MAKEFILE | checkmake MAKEFILE_CHECKMAKE | ||
PERL | Perlkritiker PERL_PERLCRITIC | ||
PHP | phpcs PHP_PHPCS | ||
PHP | phpstan PHP_phpSTAN | ||
PHP | Psalm PHP_PSALM | ||
PHP | phplint PHP_PHPLINT | ||
PHP | PHP-CS-Fixer PHP_PHPCSFIXER | ||
POWERSHELL | Powershell POWERSHELL_POWERSHELL | ||
POWERSHELL | powershell_formatter POWERSHELL_POWERSHELL_FORMATTER | ||
PYTHON | Pylint PYTHON_PYLINT | ||
PYTHON | Schwarz PYTHON_BLACK | ||
PYTHON | Flocke8 PYTHON_FLAKE8 | ||
PYTHON | isort PYTHON_ISORT | ||
PYTHON | Bandit PYTHON_BANDIT | ||
PYTHON | mypy PYTHON_MYPY | ||
PYTHON | Urheberrecht PYTHON_PYRIGHT | ||
PYTHON | Halskrause PYTHON_RUFF | ||
R | lintr R_LINTR | ||
RAKU | Raku RAKU_RAKU | ||
RUBIN | rubocop RUBY_RUBOCOP | ||
ROST | klipp RUST_CLIPPY | ||
SALESFORCE | sfdx-scanner-apex SALESFORCE_SFDX_SCANNER_APEX | ||
SALESFORCE | sfdx-scanner-aura SALESFORCE_SFDX_SCANNER_AURA | ||
SALESFORCE | sfdx-scanner-lwc SALESFORCE_SFDX_SCANNER_LWC | ||
SALESFORCE | Lightning-Flow-Scanner SALESFORCE_LIGHTNING_FLOW_SCANNER | ||
SCALA | scalafix SCALA_SCALAFIX | ||
SQL | sqlfluff SQL_SQLFLUFF | ||
SQL | tsqllint SQL_TSQLLINT | ||
SCHNELL | Swiftlint SWIFT_SWIFTLINT | ||
TSX | eslint TSX_ESLINT | ||
TYPOSKRIPT | eslint TYPESCRIPT_ES | ||
TYPOSKRIPT | ts-standard TYPESCRIPT_STANDARD | ||
TYPOSKRIPT | hübscher TYPESCRIPT_PRETTIER | ||
Visual Basic .NET (VBDOTNET) | Dotnet-Format VBDOTNET_DOTNET_FORMAT |
Format | Linter | Zusätzlich | |
---|---|---|---|
CSS | stylelint CSS_STYLELINT | ||
ENV | dotenv-linter ENV_DOTENV_LINTER | ||
GRAPHQL | graphql-schema-linter GRAPHQL_GRAPHQL_SCHEMA_LINTER | ||
HTML | djlint HTML_DJLINT | ||
HTML | htmlhint HTML_HTMLHINT | ||
JSON | jsonlint JSON_JSONLINT | ||
JSON | eslint-plugin-jsonc JSON_ESLINT_PLUGIN_JSONC | ||
JSON | v8r JSON_V8R | ||
JSON | hübscher JSON_PRETTIER | ||
JSON | npm-package-json-lint JSON_NPM_PACKAGE_JSON_LINT | ||
LATEX | chktex LATEX_CHKTEX | ||
MARKDOWN | markdownlint MARKDOWN_MARKDOWNLINT | ||
MARKDOWN | Bemerkung-Lint MARKDOWN_REMARK_LINT | ||
MARKDOWN | Markdown-Link-Check MARKDOWN_MARKDOWN_LINK_CHECK | ||
MARKDOWN | Markdown-Tabellenformatierer MARKDOWN_MARKDOWN_TABLE_FORMATTER | ||
PROTOBUF | Protolint PROTOBUF_PROTOLINT | ||
RST | erster-lint RST_RST_LINT | ||
RST | Erstcheck RST_RSTCHECK | ||
RST | rstfmt RST_RSTFMT | ||
XML | xmllint XML_XMLLINT | ||
YAML | hübscher YAML_PRETTIER | ||
YAML | Yamlint YAML_YAMLLINT | ||
YAML | v8r YAML_V8R |
Werkzeugformat | Linter | Zusätzlich | |
---|---|---|---|
AKTION | actionlint ACTION_ACTIONLINT | ||
ANSIBEL | ansible-lint ANSIBLE_ANSIBLE_LINT | ||
API | spektral API_SPECTRAL | ||
ARM | arm-ttk ARM_ARM_TTK | ||
Bizeps | bicep_linter BICEP_BICEP_LINTER | ||
WOLKENBILDUNG | cfn-lint CLOUDFORMATION_CFN_LINT | ||
DOCKERFILE | Hadolin DOCKERFILE_HADOLINT | ||
EDITORKONFIG | editorconfig-checker EDITORCONFIG_EDITORCONFIG_CHECKER | ||
GURKE | Gurken-Lint GHERKIN_GHERKIN_LINT | ||
KUBERNETES | kubekonform KUBERNETES_KUBECONFORM | ||
KUBERNETES | Helm KUBERNETES_HELM | ||
KUBERNETES | kubescape KUBERNETES_KUBESCAPE | ||
MARIONETTE | Puppenfussel PUPPET_PUPPET_LINT | ||
SCHLANGENMACHE | Schlangenmacher SNAKEMAKE_LINT | ||
SCHLANGENMACHE | Snakefmt SNAKEMAKE_SNAKEFMT | ||
TEKTON | Tekton-Lint TEKTON_TEKTON_LINT | ||
TERRAFORM | tflint TERRAFORM_TFLINT | ||
TERRAFORM | Terrascan TERRAFORM_TERRASCAN | ||
TERRAFORM | Terragrunt TERRAFORM_TERRAGRUNT | ||
TERRAFORM | terraform-fmt TERRAFORM_TERRAFORM_FMT |
Code-Qualitätsprüfer | Linter | Zusätzlich | |
---|---|---|---|
COPYPASTE | jscpd COPYPASTE_JSCPD | ||
REPOSITORY | checkov REPOSITORY_CHECKOV | ||
REPOSITORY | devskim REPOSITORY_DEVSKIM | ||
REPOSITORY | Staublocke REPOSITORY_DUSTILOCK | ||
REPOSITORY | git_diff REPOSITORY_GIT_DIFF | ||
REPOSITORY | Gitleaks REPOSITORY_GITLEAKS | ||
REPOSITORY | grype REPOSITORY_GRYPE | ||
REPOSITORY | Kicks REPOSITORY_KICS | ||
REPOSITORY | ls-lint REPOSITORY_LS_LINT | ||
REPOSITORY | Secretlint REPOSITORY_SECRETLINT | ||
REPOSITORY | semgrep REPOSITORY_SEMGREP | ||
REPOSITORY | syft REPOSITORY_SYFT | ||
REPOSITORY | trivial REPOSITORY_TRIVY | ||
REPOSITORY | trivy-sbom REPOSITORY_TRIVY_SBOM | ||
REPOSITORY | Trüffelschwein REPOSITORY_TRUFFLEHOG | ||
FLUCH | cspell SPELL_CSPELL | ||
FLUCH | proselint SPELL_PROSELINT | ||
FLUCH | Tal SPELL_VALE | ||
FLUCH | Litschi SPELL_LYCHEE |
Führen Sie einfach npx mega-linter-runner --install
im Stammverzeichnis Ihres Repositorys aus und beantworten Sie Fragen. Dadurch werden gebrauchsfertige Konfigurationsdateien für MegaLinter generiert :)
Die folgenden Anleitungsbeispiele verwenden die neueste stabile MegaLinter-Version ( v8 , entspricht immer der neuesten Version).
oxsecurity/megalinter:v8
oxsecurity/megalinter@v8
Sie können auch die Beta -Version verwenden (entsprechend dem Inhalt des Hauptzweigs).
oxsecurity/megalinter:beta
oxsecurity/megalinter@beta
.github/workflows/mega-linter.yml
HINWEISE:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
übergeben, markiert MegaLinter den Status jedes einzelnen Linter-Laufs im Abschnitt „Checks“ einer Pull-Anfrage. Andernfalls sehen Sie nur den Gesamtstatus des gesamten Laufs. Es ist nicht erforderlich, das GitHub- Geheimnis festzulegen, da es von GitHub automatisch festgelegt wird. Es muss lediglich an die Aktion übergeben werden.GITHUB_TARGET_URL
vorhanden ist. In Ihrem Repository sollte sich ein Ordner .github/workflows
mit einer GitHub- Aktion ähnlich der folgenden befinden:
.github/workflows/mega-linter.yml
---
# MegaLinter GitHub Action configuration file
# More info at https://megalinter.io
name : MegaLinter
on :
# Trigger mega-linter at every push. Action will also be visible from Pull Requests to main
push : # Comment this line to trigger action only on pull-requests (not recommended if you don't pay for GH Actions)
pull_request :
branches : [master, main]
env : # Comment env block if you don't want to apply fixes
# Apply linter fixes configuration
APPLY_FIXES : all # When active, APPLY_FIXES must also be defined as environment variable (in github/workflows/mega-linter.yml or other CI tool)
APPLY_FIXES_EVENT : pull_request # Decide which event triggers application of fixes in a commit or a PR (pull_request, push, all)
APPLY_FIXES_MODE : commit # If APPLY_FIXES is used, defines if the fixes are directly committed (commit) or posted in a PR (pull_request)
concurrency :
group : ${{ github.ref }}-${{ github.workflow }}
cancel-in-progress : true
jobs :
megalinter :
name : MegaLinter
runs-on : ubuntu-latest
permissions :
# Give the default GITHUB_TOKEN write permission to commit and push, comment issues & post new PR
# Remove the ones you do not need
contents : write
issues : write
pull-requests : write
steps :
# Git Checkout
- name : Checkout Code
uses : actions/checkout@v4
with :
token : ${{ secrets.PAT || secrets.GITHUB_TOKEN }}
fetch-depth : 0 # If you use VALIDATE_ALL_CODEBASE = true, you can remove this line to improve performances
# MegaLinter
- name : MegaLinter
id : ml
# You can override MegaLinter flavor used to have faster performances
# More info at https://megalinter.io/flavors/
uses : oxsecurity/megalinter@v8
env :
# All available variables are described in documentation
# https://megalinter.io/configuration/
VALIDATE_ALL_CODEBASE : ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }} # Validates all source when push on main, else just the git diff with main. Override with true if you always want to lint all sources
GITHUB_TOKEN : ${{ secrets.GITHUB_TOKEN }}
# ADD YOUR CUSTOM ENV VARIABLES HERE OR DEFINE THEM IN A FILE .mega-linter.yml AT THE ROOT OF YOUR REPOSITORY
# DISABLE: COPYPASTE,SPELL # Uncomment to disable copy-paste and spell checks
# Upload MegaLinter artifacts
- name : Archive production artifacts
if : success() || failure()
uses : actions/upload-artifact@v4
with :
name : MegaLinter reports
path : |
megalinter-reports
mega-linter.log
# Create pull request if applicable (for now works only on PR from same repository, not from forks)
- name : Create Pull Request with applied fixes
id : cpr
if : steps.ml.outputs.has_updated_sources == 1 && (env.APPLY_FIXES_EVENT == 'all' || env.APPLY_FIXES_EVENT == github.event_name) && env.APPLY_FIXES_MODE == 'pull_request' && (github.event_name == 'push' || github.event.pull_request.head.repo.full_name == github.repository) && !contains(github.event.head_commit.message, 'skip fix')
uses : peter-evans/create-pull-request@v6
with :
token : ${{ secrets.PAT || secrets.GITHUB_TOKEN }}
commit-message : " [MegaLinter] Apply linters automatic fixes "
title : " [MegaLinter] Apply linters automatic fixes "
labels : bot
- name : Create PR output
if : steps.ml.outputs.has_updated_sources == 1 && (env.APPLY_FIXES_EVENT == 'all' || env.APPLY_FIXES_EVENT == github.event_name) && env.APPLY_FIXES_MODE == 'pull_request' && (github.event_name == 'push' || github.event.pull_request.head.repo.full_name == github.repository) && !contains(github.event.head_commit.message, 'skip fix')
run : |
echo "Pull Request Number - ${{ steps.cpr.outputs.pull-request-number }}"
echo "Pull Request URL - ${{ steps.cpr.outputs.pull-request-url }}"
# Push new commit if applicable (for now works only on PR from same repository, not from forks)
- name : Prepare commit
if : steps.ml.outputs.has_updated_sources == 1 && (env.APPLY_FIXES_EVENT == 'all' || env.APPLY_FIXES_EVENT == github.event_name) && env.APPLY_FIXES_MODE == 'commit' && github.ref != 'refs/heads/main' && (github.event_name == 'push' || github.event.pull_request.head.repo.full_name == github.repository) && !contains(github.event.head_commit.message, 'skip fix')
run : sudo chown -Rc $UID .git/
- name : Commit and push applied linter fixes
if : steps.ml.outputs.has_updated_sources == 1 && (env.APPLY_FIXES_EVENT == 'all' || env.APPLY_FIXES_EVENT == github.event_name) && env.APPLY_FIXES_MODE == 'commit' && github.ref != 'refs/heads/main' && (github.event_name == 'push' || github.event.pull_request.head.repo.full_name == github.repository) && !contains(github.event.head_commit.message, 'skip fix')
uses : stefanzweifel/git-auto-commit-action@v4
with :
branch : ${{ github.event.pull_request.head.ref || github.head_ref || github.ref }}
commit_message : " [MegaLinter] Apply linters fixes "
commit_user_name : megalinter-bot
commit_user_email : [email protected]
Erstellen oder aktualisieren Sie die Datei .gitlab-ci.yml
im Stammverzeichnis Ihres Repositorys
# MegaLinter GitLab CI job configuration file
# More info at https://megalinter.io/
mega-linter :
stage : test
# You can override MegaLinter flavor used to have faster performances
# More info at https://megalinter.io/flavors/
image : oxsecurity/megalinter:v8
script : [ "true" ] # if script: ["true"] doesn't work, you may try -> script: [ "/bin/bash /entrypoint.sh" ]
variables :
# All available variables are described in documentation
# https://megalinter.io/configuration/
DEFAULT_WORKSPACE : $CI_PROJECT_DIR
# ADD YOUR CUSTOM ENV VARIABLES HERE TO OVERRIDE VALUES OF .mega-linter.yml AT THE ROOT OF YOUR REPOSITORY
artifacts :
when : always
paths :
- megalinter-reports
expire_in : 1 week
Erstellen Sie ein Gitlab-Zugriffstoken und definieren Sie es in einer Variablen GITLAB_ACCESS_TOKEN_MEGALINTER in den CI/CD-maskierten Variablen des Projekts. Stellen Sie sicher, dass Ihr Token (z. B. ein Projekt-Token) die entsprechende Rolle zum Kommentieren einer Zusammenführungsanforderung hat (zumindest Entwickler).
Unsere Freunde bei R2Devops haben einen Gitlab-CI-MegaLinter-Workflow auf ihrem Open-Source-Vorlagen-Marktplatz gepackt und können MegaLinter-Ergebnisse in Gitlab-Codequalitätsberichten veröffentlichen!
Verwenden Sie die folgende Azure Pipelines YAML-Vorlage
Sie können eine Build-Validierungszweigrichtlinie für ein einzelnes Repository oder für alle Repositorys konfigurieren. Wenn Sie über alle Repositorys hinweg konfigurieren, wird Ihre Pipeline in einem zentralen Repository gespeichert.
Fügen Sie einer azure-pipelines.yaml
Datei in Ihrem Code-Repository Folgendes hinzu:
# Run MegaLinter to detect linting and security issues
- job : MegaLinter
pool :
vmImage : ubuntu-latest
steps :
# Checkout repo
- checkout : self
# Pull MegaLinter docker image
- script : docker pull oxsecurity/megalinter:v8
displayName : Pull MegaLinter
# Run MegaLinter
- script : |
docker run -v $(System.DefaultWorkingDirectory):/tmp/lint
--env-file <(env | grep -e SYSTEM_ -e BUILD_ -e TF_ -e AGENT_)
-e SYSTEM_ACCESSTOKEN=$(System.AccessToken)
-e GIT_AUTHORIZATION_BEARER=$(System.AccessToken)
oxsecurity/megalinter:v8
displayName: Run MegaLinter
# Upload MegaLinter reports
- task : PublishPipelineArtifact@1
condition : succeededOrFailed()
displayName : Upload MegaLinter reports
inputs :
targetPath : " $(System.DefaultWorkingDirectory)/megalinter-reports/ "
artifactName : MegaLinterReport
Fügen Sie einer azure-pipelines.yaml
Datei in einem separaten Repository, z. B. dem „MegaLinter“-Repository, Folgendes hinzu:
# Run MegaLinter to detect linting and security issues
trigger : none
pool :
vmImage : ubuntu-latest
variables :
repoName : $[ replace(split(variables['System.PullRequest.SourceRepositoryURI'], '/')[6], '%20', ' ') ]
steps :
# Checkout triggering repo
- checkout : git://$(System.TeamProject)/$(repoName)@$(System.PullRequest.SourceBranch)
displayName : Checkout Triggering Repository
# Pull MegaLinter docker image
- script : docker pull oxsecurity/megalinter:v8
displayName : Pull MegaLinter
# Run MegaLinter
- script : |
docker run -v $(System.DefaultWorkingDirectory):/tmp/lint
--env-file <(env | grep -e SYSTEM_ -e BUILD_ -e TF_ -e AGENT_)
-e SYSTEM_ACCESSTOKEN=$(System.AccessToken)
-e GIT_AUTHORIZATION_BEARER=$(System.AccessToken)
oxsecurity/megalinter:v8
displayName: Run MegaLinter
# Upload MegaLinter reports
- task : PublishPipelineArtifact@1
condition : succeededOrFailed()
displayName : MegaLinter Report
inputs :
targetPath : $(System.DefaultWorkingDirectory)/megalinter-reports/
artifactName : MegaLinterReport
Um von Pull-Request-Kommentaren zu profitieren, befolgen Sie bitte die Konfigurationsanweisungen
Sie können auch diesem ausführlichen Tutorial von DonKoning folgen
Erstellen Sie eine bitbucket-pipelines.yml
Datei im Stammverzeichnis Ihres Repositorys
Kopieren Sie die folgende Vorlage und fügen Sie sie ein oder fügen Sie den Schritt Ihrer vorhandenen Pipeline hinzu.
image : atlassian/default-image:3
pipelines :
default :
- parallel :
- step :
name :
Expandieren