Skip to content

Commit d87f2fe

Browse files
committed
Add more information about exclusions
1 parent ddb3f0e commit d87f2fe

File tree

2 files changed

+22
-0
lines changed

2 files changed

+22
-0
lines changed

doc/changes/unreleased.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
## Documentation
44

55
* #589: Corrected configuration for Sonar documentation for host.url
6+
* #535: Added more information about Sonar's usage of ``exclusions``
67

78
## Refactoring
89

doc/user_guide/features/metrics/sonar.rst

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,16 @@ In the code
6161
organization = "exasol"
6262
exclusions = "<source-directory>/version.py,<source_directory>/<directory-to-ignore>/*"
6363
64+
.. note::
65+
With the value of ``exclusions``, you can exclude files and directories of your
66+
project from Sonar's analysis:
67+
68+
* You can use wildcards, e.g. ``<root>/dir/*.py`` or ``<root>/**/*.py``
69+
* Multiple exclusions can be comma-separated (as shown above).
70+
* For excluding arbitrary directories and files below a specific directory, please use two asterisks, e.g. ``root/abc/**``.
71+
72+
See the `Sonar Matching Patterns`_ for more details.
73+
6474
.. _configure_sonar_private_project:
6575

6676
**Private** GitHub repository
@@ -107,3 +117,14 @@ In the code
107117
exclusions = "<source-directory>/version.py,<source_directory>/<directory-to-ignore>/*"
108118
109119
.. _Exasol Way: https://sonarcloud.io/organizations/exasol/quality_gates/show/AXxvLH-3BdtLlpiYmZhh
120+
.. _Sonar Matching Patterns: https://docs.sonarsource.com/sonarqube-server/project-administration/setting-analysis-scope/defining-matching-patterns
121+
122+
.. note::
123+
With the value of ``exclusions``, you can exclude files and directories of your
124+
project from Sonar's analysis:
125+
126+
* You can use wildcards, e.g. ``<root>/dir/*.py`` or ``<root>/**/*.py``
127+
* Multiple exclusions can be comma-separated (as shown above).
128+
* For excluding arbitrary directories and files below a specific directory, please use two asterisks, e.g. ``root/abc/**``.
129+
130+
See the `Sonar Matching Patterns`_ for more details.

0 commit comments

Comments
 (0)