From e481384ac8f4a518ea47bd29f3b2a4b3df98db8d Mon Sep 17 00:00:00 2001 From: Diamantis Sellis Date: Tue, 13 May 2025 11:07:35 +0200 Subject: [PATCH] docs: update scanner config docs --- sonar-project.properties | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/sonar-project.properties b/sonar-project.properties index dbb6737c..46714b8d 100644 --- a/sonar-project.properties +++ b/sonar-project.properties @@ -1,2 +1,36 @@ +# CosmoTech template for SonarQube configuration v0.7.0 +# ----------------------------------------------------- + +# This file is used to configure the SonarQube scanner for a project (source: +# https://github.com/Cosmo-Tech/sonarqube-scanner/blob/main/docs/sonar-project.properties.template) + + +# Default project identification properties +# ----------------------------------------- +# These properties are hardcoded in the sonarqube-scanner as they are shared +# across all CosmoTech projects. Uncomment them only if you want to override +# and you know what you are doing. + +# sonar.projectKey=your-project-key # Unique identifier for your project +# sonar.projectName=Your Project Name # Display name for your project +# sonar.projectVersion=1.0.0 # Version of your project + +# Source code and testing configuration +# ----------------------------------- +# A file should either be in source or test directory, not both. By default +# everything is source +# Define source directories to analyze: sonar.sources=cosmotech +# Define test directories: sonar.tests=tests + +# Completely ignore files with the following patterns: +# sonar.exclusions=do_not_look_inside/** + +# Code duplication detection settings +# sonar.cpd.exclusions=embarassing_code/**,copy_pasted_scripts/** + +# Language-specific configurations +# ------------------------------ +# Python version(s) used in the project (comma-separated list of supported versions) +sonar.python.version=3.11