README.tpl.md

sonar-scala-docker

Docker images and docker-compose recipes for out-of-the-box SonarQube {{current.sonar}}, SonarQube 8.9 LTS, SonarQube 7.9 LTS and SonarQube 6.7 LTS instance with support for Scala, Scoverage (code coverage metrics) and Scalastyle + Scapegoat (static code analysis). :sunglasses:

Usage

To start SonarQube in a daemon mode, simply run:

docker-compose up -d

or the following for the LTS version:

docker-compose -f docker-compose-lts.yml up -d

Once docker pulls all the required images and starts up the containers, the application should become available on http://localhost. The default SonarQube login details for the Administrator account are admin:admin.

You can also use a standalone docker image which contains SonarQube server with bundled sonar-scala plugin, mwizner/sonarqube-scala-plugins:{{current.version}}-full(or mwizner/sonarqube-scala-plugins:latest-full) and mwizner/sonarqube-scala-plugins:{{lts.version}}-full (or mwizner/sonarqube-scala-plugins:latest-lts-full) for the current LTS version. Alternatively, we also provide an image for the old SonarQube 7.9 LTS version - mwizner/sonarqube-scala-plugins:{{lts79.version}}-full and SonarQube 6.7 LTS version - mwizner/sonarqube-scala-plugins:{{lts67.version}}-full

To start the container issue the following command:
See the version compatibility matrix below to determine which version you should use.

docker run -d \
  --name sonarqube-scala-plugins-full \
  -p 80:9000 \
  -e SONARQUBE_JDBC_USERNAME=sonar \
  -e SONARQUBE_JDBC_PASSWORD=sonar \
  -e SONARQUBE_JDBC_URL=jdbc:postgresql://localhost/sonar \
  mwizner/sonarqube-scala-plugins:{{current.version}}-full

Please note that if you don't specify the SONARQUBE_JDBC_URL variable, SonarQube will use an embedded H2 database, which is not recommended in production, but if you don't have access to an existing database or you just want to try the image, you can use the following command:

docker run -d \
  --name sonarqube-scala-plugins-full \
  -p 80:9000 \
  mwizner/sonarqube-scala-plugins:{{current.version}}-full

Dependencies

• SonarQube {{current.sonar}} or SonarQube 8.9 LTS or SonarQube 7.9 LTS or SonarQube 6.7 LTS
• PostgreSQL 12/13
• mwz/sonar-scala - provides support for scalastyle, scoverage and scapegoat

(versions before 2.7.0 used arthepsy/sonar-scala-extra for scapegoat support)

Compatibility Matrix

Version	SonarQube	sonar-scala
{{current.version}}	{{current.sonar}} documentation, changelog	{{current.sonarScala}}
{{lts.version}}	{{lts.sonar}} documentation, changelog	{{lts.sonarScala}}
{{lts79.version}}	{{lts79.sonar}} documentation, changelog	{{lts.sonarScala}}
{{lts67.version}}	{{lts67.sonar}} documentation, changelog	{{lts67.sonarScala}}

Other versions

{{#versions.current}} {{/versions.current}} {{#versions.lts}} {{/versions.lts}}

Version	SonarQube	sonar-scala	sonar-scala-extra
{{version}}	{{sonar}} documentation, changelog	{{sonarScala}}
{{version}}	{{sonar}} documentation, changelog	{{sonarScala}}	{{#sonarScalaExtra}}{{sonarScalaExtra}}{{/sonarScalaExtra}}

Please note, that starting from version 2.7.0, the images no longer contain the sonar-scala-extra plugin as sonar-scala provides Scapegoat support from version 6.5.0 onwards.

Recommendations

sbt-sonar is an sbt plugin which provides a way to automate analysis of Scala projects with SonarQube.

Changelog

Expand to see the changelog.

• 5.8.0 - Upgraded sonar-scala to 8.9.0 & SonarQube to 8.9.4.
• 5.7.0 - Upgraded sonar-scala to 8.7.0 & SonarQube to 8.7.1.
• 5.6.0 - Upgraded sonar-scala to 8.6.0 & SonarQube to 8.5.1.
• 5.5.0 - Upgraded sonar-scala to 8.5.0 & SonarQube to 8.4.
• 5.4.0 - Upgraded sonar-scala to 8.4.0.
• 5.3.0 - Upgraded sonar-scala to 8.3.0 & SonarQube to 8.3.
• 5.2.0 - Upgraded sonar-scala to 8.2.0 & SonarQube to 8.2.
• 5.1.0 - Upgraded sonar-scala to 8.1.0.
• 5.0.0 - Upgraded sonar-scala to 8.0.0 & SonarQube to 8.1.
• 4.2.0 - Upgraded sonar-scala to 7.9.0.
• 4.1.0 - Upgraded sonar-scala to 7.8.0.
• 4.0.0 - Upgraded sonar-scala to 7.7.0 & SonarQube to 7.9.1 LTS.
• 3.7.0 - Upgraded sonar-scala to 7.6.0 & SonarQube to 7.8.
• 3.6.0 - Upgraded sonar-scala to 7.5.0 & SonarQube to 7.7.
• 3.5.0 - Upgraded sonar-scala to 7.4.0 & SonarQube to 7.6.
• 3.4.0 - Upgraded sonar-scala to 7.3.1.
• 3.3.0 - Upgraded sonar-scala to 7.3.0.
• 3.2.1 - Fixed file system permissions.
• 3.2.0 - Upgraded sonar-scala to 7.2.0.
• 3.1.0 - Upgraded sonar-scala to 7.1.0 & SonarQube to 7.4.
• 3.0.0 - Upgraded sonar-scala to 7.0.0 & SonarQube to 7.3.
• 2.12.0 - Upgraded SonarQube to 6.7.7 LTS.
• 2.11.0 - Upgraded sonar-scala to 6.8.0.
• 2.10.0 - Upgraded sonar-scala to 6.7.0 & SonarQube to 6.7.6.
• 2.9.0 - Upgraded sonar-scala to 6.6.0.
• 2.8.0 - Upgraded sonar-scala to 6.5.1 & SonarQube to 6.7.5.
• 2.7.0 - Upgraded sonar-scala to 6.5.0, which brings support for scapegoat.
• 2.6.0 - Upgraded SonarQube to 6.7.4.
• 2.5.0 - Upgraded sonar-scala to 6.4.0.
• 2.4.0 - Upgraded sonar-scala to 6.3.0.
• 2.3.0 - Upgraded sonar-scala to 6.2.0.
• 2.2.1 - Upgraded SonarQube to 6.7.3 LTS.
• 2.2.0 - Upgraded sonar-scala to 6.1.0 & SonarQube to 6.7.2 LTS.
• 2.1.0 - Published docker image with Scala plugins to dockerhub [mwizner/sonarqube-scala-plugins](https://hub.docker.com/r/mwizner/sonarqube-scala-plugins).
• 2.0.0 - SonarQube 6.7.1 LTS.
• 1.0.0 - SonarQube 5.6.7 LTS.

License

The project is licensed under the Apache License v2. See the LICENSE file for more details.