En utilisant cette action GitHub, scannez votre code avec le scanner Sonarqube pour détecter les bogues, les vulnérabilités et les odeurs de code dans plus de 20 langages de programmation!
Sonarqube est une plate-forme open source développée par Sonarsource pour une inspection continue de la qualité du code pour effectuer des revues automatiques avec une analyse statique du code pour détecter les bogues, les odeurs de code et les vulnérabilités de sécurité sur plus de 20 langages de programmation.
Le workflow, généralement déclaré dans .github/workflows/build.yaml , ressemble à:
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 }}Vous pouvez modifier le répertoire de base d'analyse et / ou la clé de projet en utilisant l'entrée facultative comme celle-ci:
uses : kitabisa/sonarqube-action@master
with :
host : ${{ secrets.SONARQUBE_HOST }}
login : ${{ secrets.SONARQUBE_TOKEN }}
projectBaseDir : " src/ "
projectKey : " my-custom-project "Ce sont quelques-uns des paramètres d'entrée pris en charge de l'action.
| Paramètre | Description | Requis? | Défaut | Note |
|---|---|---|---|---|
host | URL du serveur Sonarqube | ? | ||
login | Jeton de connexion ou d'authentification d'un utilisateur Sonarqube | ? | Execute Analysis requise. | |
password | Le mot de passe qui accompagne le nom d'utilisateur login | ? | Cela doit être laissé vide si une login est un jeton d'authentification. | |
projectBaseDir | Définir l'analyse du répertoire de base de projet personnalisé | ? | . | |
projectKey | La clé unique du projet | ? | Les caractères autorisés sont: des lettres, des chiffres, - , _ , . et : avec au moins un non-chiffre. | |
projectName | Nom du projet | ? | Il sera affiché sur l'interface Web Sonarqube. | |
projectVersion | La version du projet | ? | ||
encoding | Encodage du code source | ? | UTF-8 |
Note
Si vous choisissez de configurer les métadonnées du projet et d'autres paramètres connexes dans un fichier sonar-project.properties (doit être placé dans le répertoire de base, projectBaseDir ) au lieu d'utiliser des paramètres d'entrée, cette action est compatible avec cette approche!
Le dockerfile et les scripts et la documentation associés dans ce projet sont publiés sous la licence MIT.
Les images de conteneurs construites avec ce projet comprennent des matériaux tiers.