sonarqube action

Sonarqube Github Action

Scannen Sie mit dieser GitHub -Aktion Ihren Code mit Sonarqube -Scanner, um Fehler, Schwachstellen und Codegerüche in mehr als 20 Programmiersprachen zu erkennen!

Sonarqube ist eine Open-Source-Plattform, die von SonarSource für kontinuierliche Überprüfung der Codequalität entwickelt wurde, um automatische Bewertungen mit statischer Analyse von Code zum Erkennen von Fehler, Codegerüchen und Sicherheitslücken in über 20 Programmiersprachen zu erkennen.

Anforderungen

• Sonarqube Server.
• Das ist alles!

Verwendung

Der Workflow, der normalerweise in .github/workflows/build.yaml deklariert wird, sieht aus wie:

 on :
  # Trigger analysis when pushing in master or pull requests, and when creating
  # a pull request. 
  push :
    branches :
      - master
  pull_request :
      types : [opened, synchronize, reopened]

name : SonarQube Scan
jobs :
  sonarqube :
    name : SonarQube Trigger
    runs-on : ubuntu-latest
    steps :
    - name : Checking out
      uses : actions/checkout@master
      with :
        # Disabling shallow clone is recommended for improving relevancy of reporting
        fetch-depth : 0
    - name : SonarQube Scan
      uses : kitabisa/[email protected]
      with :
        host : ${{ secrets.SONARQUBE_HOST }}
        login : ${{ secrets.SONARQUBE_TOKEN }}

Sie können das Analyse -Basisverzeichnis und/oder den Projektschlüssel ändern, indem Sie die optionale Eingabe wie folgt verwenden:

 uses : kitabisa/sonarqube-action@master
with :
  host : ${{ secrets.SONARQUBE_HOST }}
  login : ${{ secrets.SONARQUBE_TOKEN }}
  projectBaseDir : " src/ "
  projectKey : " my-custom-project "

Eingänge

Dies sind einige der unterstützten Eingabeparameter der Aktion.

Parameter	Beschreibung	Erforderlich?	Standard	Notiz
host	Sonarqube Server URL	?
login	Login- oder Authentifizierungs -Token eines Sonarqube -Benutzers	?		Execute Analysis erforderlich.
password	Das Passwort, das mit dem login entspricht	?		Dies sollte leer bleiben, wenn ein login Authentifizierungs -Token ist.
projectBaseDir	Stellen Sie die benutzerdefinierte Projektbasisverzeichnisanalyse fest	?	.
projectKey	Der einzigartige Schlüssel des Projekts	?		Zugelassene Zeichen sind: Buchstaben, Zahlen, - , _ , . und : mit mindestens einem nicht-digit.
projectName	Name des Projekts	?		Es wird auf der Sonarqube -Weboberfläche angezeigt.
projectVersion	Die Projektversion	?
encoding	Codierung des Quellcode	?	UTF-8

Notiz

Wenn Sie sich für die Konfiguration der Projektmetadaten und anderer zugehöriger Einstellungen in einer sonar-project.properties -Datei (in das Basisverzeichnis projectBaseDir ) konfigurieren, anstatt Eingabeparameter zu verwenden, ist diese Aktion mit diesem Ansatz kompatibel!

Lizenz

Die Dockerfile und die zugehörigen Skripte und die Dokumentation in diesem Projekt werden unter der MIT -Lizenz veröffentlicht.

Mit diesem Projekt erstellte Containerbilder enthalten Materialien von Drittanbietern.