SonarQubePrepare@4 - Préparer la configuration de l’analyse v4

Article
05/14/2024

Utilisez cette tâche pour préparer une configuration d’analyse SonarQube.

Syntax

# Prepare Analysis Configuration v4
# Prepare SonarQube analysis configuration.
- task: SonarQubePrepare@4
  inputs:
    SonarQube: # string. Required. SonarQube Server Endpoint. 
    scannerMode: 'MSBuild' # 'MSBuild' | 'Other' | 'CLI'. Required. Choose the way to run the analysis. Default: MSBuild.
    #configMode: 'file' # 'file' | 'manual'. Required when scannerMode = CLI. Mode. Default: file.
    #configFile: 'sonar-project.properties' # string. Optional. Use when scannerMode = CLI && configMode = file. Settings File. Default: sonar-project.properties.
    #cliProjectKey: # string. Required when scannerMode = CLI && configMode = manual. Project Key. 
    projectKey: # string. Required when scannerMode = MSBuild. Project Key. 
    #cliProjectName: # string. Optional. Use when scannerMode = CLI && configMode = manual. Project Name. 
    #projectName: # string. Optional. Use when scannerMode = MSBuild. Project Name. 
    #cliProjectVersion: '1.0' # string. Optional. Use when scannerMode = CLI && configMode = manual. Project Version. Default: 1.0.
    #projectVersion: '1.0' # string. Optional. Use when scannerMode = MSBuild. Project Version. Default: 1.0.
    #cliSources: '.' # string. Required when scannerMode = CLI && configMode = manual. Sources directory root. Default: ..
  # Advanced
    #extraProperties: # string. Additional Properties.

Entrées

SonarQube - Point de terminaison du serveur SonarQube
string. Obligatoire.

Spécifie le point de terminaison de serveur SonarQube pour votre projet. Pour en créer un, cliquez sur le Manage lien, créez un nouveau point de terminaison de serveur SonarQube, puis entrez l’URL et le jeton de votre serveur.

scannerMode - Choisir la façon d’exécuter l’analyse
string. Obligatoire. Valeurs autorisées : MSBuild (Intégrer à MSBuild), Other (Intégrer à Maven ou Gradle), CLI (Utiliser un scanneur autonome). Valeur par défaut : MSBuild.

MSBuild

Placez cette tâche avant votre tâche MSBuild.
Ajoutez la Run Code Analysis tâche après les tâches MSBuild/VSTest.

Maven/Gradle

Placez cette tâche avant la tâche Maven/Gradle.
Cochez la Run SonarQube Analysis case dans la configuration de la tâche Maven/Gradle.

Autres

Dans d’autres cas, vous pouvez utiliser le scanneur autonome (sonar-scanner), définir toutes les configurations avec cette tâche, puis ajouter la Run Code Analysis tâche.

configMode - Mode
string. Obligatoire quand scannerMode = CLI. Valeurs autorisées : file (Configuration du stockage avec mon code source (sonar-project.properties)), manual (fournir manuellement la configuration). Valeur par défaut : file.

Spécifie votre méthode de configuration préférée.

configFile - Fichier de paramètres
string. facultatif. Utilisez quand scannerMode = CLI && configMode = file. Valeur par défaut : sonar-project.properties.

Spécifie les paramètres de configuration et les propriétés du projet. En savoir plus sur l’extension SonarQube pour Azure DevOps.

cliProjectKey - Clé de projet
string. Obligatoire quand scannerMode = CLI && configMode = manual.

Spécifie la clé unique du projet SonarQube. Par exemple : sonar.projectKey.

projectKey - Clé de projet
string. Obligatoire quand scannerMode = MSBuild.

Spécifie la clé unique du projet SonarQube. Par exemple : sonar.projectKey.

cliProjectName - Nom du projet
string. facultatif. Utilisez quand scannerMode = CLI && configMode = manual.

Spécifie le nom du projet SonarQube. Par exemple : sonar.projectName.

projectName - Nom du projet
string. facultatif. Utilisez quand scannerMode = MSBuild.

Spécifie le nom du projet SonarQube. Par exemple : sonar.projectName.

cliProjectVersion - Version du projet
string. facultatif. Utilisez quand scannerMode = CLI && configMode = manual. Valeur par défaut : 1.0.

Spécifie la version du projet SonarQube. Par exemple : sonar.projectVersion.

projectVersion - Version du projet
string. facultatif. Utilisez quand scannerMode = MSBuild. Valeur par défaut : 1.0.

Spécifie la version du projet SonarQube. Par exemple : sonar.projectVersion.

cliSources - Racine du répertoire sources
string. Obligatoire quand scannerMode = CLI && configMode = manual. Valeur par défaut : ..

Spécifie le chemin d’accès au répertoire racine contenant les fichiers sources. Cette valeur est définie sur la sonar.sources propriété SonarQube.

extraProperties - Propriétés supplémentaires
string. Valeur par défaut : # Additional properties that will be passed to the scanner, \n# Put one key=value per line, example:\n# sonar.exclusions=**/*.bin.

Spécifie des propriétés supplémentaires à passer au scanneur. Spécifiez chaque key=value paire sur une nouvelle ligne.

Options de contrôle des tâches

Toutes les tâches ont des options de contrôle en plus de leurs entrées de tâches. Pour plus d’informations, consultez Options de contrôle et propriétés de tâche courantes.

Variables de sortie

Aucun.

Notes

Prendre en charge les projets non-MSBuild : Cette tâche peut également configurer l’analyse pour les projets non-MSBuild.

Configuration requise

Condition requise	Description
Types de pipelines	YAML, build classique
S’exécute sur	Agent, DeploymentGroup
Demandes	Aucun
Capabilities	Cette tâche ne répond à aucune demande pour les tâches suivantes dans le travail.
Restrictions de commande	Quelconque
Variables paramétrables	Quelconque
Version de l’agent	1.95.1 ou version ultérieure
Catégorie de la tâche	Build

Voir aussi

SonarQube Azure DevOps Integration

Partager via