diff --git a/Dockerfile b/Dockerfile index 008ffa2..02e4f4b 100644 --- a/Dockerfile +++ b/Dockerfile @@ -10,7 +10,7 @@ LABEL org.opencontainers.image.documentation="https://raw.githubusercontent.com/ LABEL org.opencontainers.image.source="https://raw.githubusercontent.com/ICTU/sonar/master/Dockerfile" LABEL org.opencontainers.image.vendor="ICTU" LABEL org.opencontainers.image.title="ICTU SonarQube" -LABEL org.opencontainers.image.description="A SonarQube image containing plugins, profiles and config used at ICTU" +LABEL org.opencontainers.image.description="A SonarQube container image with plugins, profiles and config used at ICTU" USER root diff --git a/README.md b/README.md index 553e4ad..46fb525 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # ICTU SonarQube container image -A sonar image containing plugins and quality profiles used at ICTU. +A SonarQube container image with plugins, profiles and config used at ICTU ## Creating a new quality profile @@ -17,21 +17,16 @@ Alternatively, the automatic overriding of default profile can be avoided by ens Add the project code (it will be used as a prefix for the quality profile name) to the environment variable `PROJECT_CODE`. Add a list of semicolon separated rule ids to be enabled or disabled to the environment variable `PROJECT_RULES`. -Example: +Example to explicitly enable (+) a C# rule and disable (-) a TypeScript rule: PROJECT_CODE=PROJ1 PROJECT_RULES=+csharpsquid:S104;-ts:S1561 -It is also possible to adjust rule parameter values: +It is also possible to adjust individual rule parameter values: PROJECT_CODE=PROJ1 PROJECT_RULES=+csharpsquid:S110|max=6;-ts:S1561 -And change severity: - - PROJECT_CODE=PROJ1 - PROJECT_RULES=-squid:S4274;+csharpsquid:S110|max=7&severity=INFO;+csharpsquid:S3925&severity=INFO - ## Running with PostgreSQL via a docker composition