SonarQubePrepare@4 - Préparer la tâche De configuration d’analyse v4

Article
11/07/2024

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

Note

Cette tâche est déconseillée ; utilisez SonarQubePrepare@7.

Syntaxe

# 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 de serveur SonarQube
string. Obligatoire.

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

scannerMode - Choisir le moyen d’exécuter l’analyse
string. Obligatoire. Valeurs autorisées : MSBuild (Intégrer à MSBuild), Other (Intégrer avec 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 tâche Run Code Analysis après les tâches MSBuild/VSTest.

Maven/Gradle

Placez cette tâche avant la tâche Maven/Gradle.
Cochez la case Run SonarQube Analysis 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 tâche Run Code Analysis.

mode
string. Obligatoire lorsque scannerMode = CLI. Valeurs autorisées : file (configuration du Windows Store 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.

fichier de paramètres configFile -
string. Optionnel. 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 lorsque scannerMode = CLI && configMode = manual.

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

projectKey - clé de projet
string. Obligatoire lorsque scannerMode = MSBuild.

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

cliProjectName - nom du projet
string. Optionnel. Utilisez quand scannerMode = CLI && configMode = manual.

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

projectName - nom du projet
string. Optionnel. Utilisez quand scannerMode = MSBuild.

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

cliProjectVersion - version du projet
string. Optionnel. 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. Optionnel. 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 lorsque scannerMode = CLI && configMode = manual. Valeur par défaut : ..

Spécifie le chemin d’accès au répertoire racine contenant des fichiers sources. Cette valeur est définie sur la propriété sonar.sources 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 propriétés supplémentaires à passer au scanneur. Spécifiez chaque paire key=value sur une nouvelle ligne.

Options de contrôle de tâche

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

Variables de sortie

Aucun.

Remarques

Note

Cette tâche est déconseillée ; utilisez SonarQubePrepare@7.

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

Exigences

Exigence	Description
Types de pipelines	YAML, build classique
Exécutions sur	Agent, DeploymentGroup
demandes	Aucun
fonctionnalités de	Cette tâche ne répond à aucune demande de tâches ultérieures dans le travail.
restrictions de commande	Quelconque
variables settables	Quelconque
Version de l’agent	2.144.0 ou version ultérieure
Catégorie de tâche	Construire

Voir aussi

SonarQube Azure DevOps Integration

Partager via