diff --git a/README.md b/README.md index 814670e..832af44 100644 --- a/README.md +++ b/README.md @@ -14,16 +14,16 @@ docker-compose up -d Once docker pulls all the required images and starts up the containers, the application should become available on [http://localhost](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 LTS with bundled Scala plugins [`mwizner/sonarqube-scala-plugins:2.2.1-full`](https://hub.docker.com/r/mwizner/sonarqube-scala-plugins). +You can also use a standalone docker image which contains SonarQube LTS with bundled Scala plugins [`mwizner/sonarqube-scala-plugins:2.3.0-full`](https://hub.docker.com/r/mwizner/sonarqube-scala-plugins). To start the container issue the following command: ```bash -$ docker run -d --name sonarqube-scala-plugins-full \ +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:2.2.1-full + mwizner/sonarqube-scala-plugins:2.3.0-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. @@ -38,6 +38,7 @@ Please note that if you don't specify the `SONARQUBE_JDBC_URL` variable, SonarQu ## Compatibility Matrix Version | SonarQube | sonar-scala | sonar-scala-extra --------|-----------|-------------|------------------ +[2.3.0](https://github.com/mwz/sonarqube-scala-docker/releases/tag/2.3.0) | 6.7.3 LTS ([documentation](https://docs.sonarqube.org/display/SONARQUBE67/Documentation)) ([changelog](https://jira.sonarsource.com/jira/secure/ReleaseNote.jspa?projectId=10930&version=14264)) | [6.2.0](https://github.com/mwz/sonar-scala/releases/tag/v6.2.0) | [1.3.0](https://github.com/arthepsy/sonar-scala-extra/releases/tag/v1.3.0) [2.2.1](https://github.com/mwz/sonarqube-scala-docker/releases/tag/2.2.1) | 6.7.3 LTS ([documentation](https://docs.sonarqube.org/display/SONARQUBE67/Documentation)) ([changelog](https://jira.sonarsource.com/jira/secure/ReleaseNote.jspa?projectId=10930&version=14264)) | [6.1.0](https://github.com/mwz/sonar-scala/releases/tag/v6.1.0) | [1.3.0](https://github.com/arthepsy/sonar-scala-extra/releases/tag/v1.3.0) [2.2.0](https://github.com/mwz/sonarqube-scala-docker/releases/tag/2.2.0) | 6.7.2 LTS ([documentation](https://docs.sonarqube.org/display/SONARQUBE67/Documentation)) ([changelog](https://jira.sonarsource.com/jira/secure/ReleaseNote.jspa?projectId=10930&version=14191)) | [6.1.0](https://github.com/mwz/sonar-scala/releases/tag/v6.1.0) | [1.3.0](https://github.com/arthepsy/sonar-scala-extra/releases/tag/v1.3.0) [2.1.0](https://github.com/mwz/sonarqube-scala-docker/releases/tag/2.1.0), [2.0.0](https://github.com/mwz/sonarqube-scala-docker/releases/tag/2.0.0) | 6.7.1 LTS ([documentation](https://docs.sonarqube.org/display/SONARQUBE67/Documentation)) ([changelog](https://jira.sonarsource.com/jira/secure/ReleaseNote.jspa?projectId=10930&version=14137)) | [6.0.0](https://github.com/mwz/sonar-scala/releases/tag/v6.0.0) | [1.3.0](https://github.com/arthepsy/sonar-scala-extra/releases/tag/v1.3.0) @@ -48,6 +49,7 @@ Version | SonarQube | sonar-scala | sonar-scala-extra [sbt-sonar](https://github.com/mwz/sbt-sonar) is an sbt plugin which provides a way to automate analysis of Scala projects with SonarQube. ## Changelog +- **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). diff --git a/README_DOCKERHUB.md b/README_DOCKERHUB.md index 3a51cc2..76e8d9b 100644 --- a/README_DOCKERHUB.md +++ b/README_DOCKERHUB.md @@ -1,12 +1,69 @@ Docker images with out-of-the-box [SonarQube LTS](https://www.sonarqube.org) instance with support for [Scala](http://www.scala-lang.org), [Scoverage](https://github.com/scoverage/scalac-scoverage-plugin) (code coverage metrics) and [Scalastyle](http://www.scalastyle.org) + [Scapegoat](https://github.com/sksamuel/scapegoat) (static code analysis). :sunglasses: ## Available versions -- `2.2.1`, `latest` [Dockerfile](https://github.com/mwz/sonar-scala-docker/blob/master/2.1.0/Dockerfile), [(v2.2.1)](https://github.com/mwz/sonar-scala-docker/releases/tag/2.2.1) + +There are two types of images available: images with [sonar-scala](https://github.com/mwz/sonar-scala) and [sonar-scala-extra](https://github.com/arthepsy/sonar-scala-extra) plugins which can be mounted as a volume into a SonarQube container and images which bundle those plugins with SonarQube (suffixed with `-full`). + +- `2.3.0`, `latest` [Dockerfile](https://github.com/mwz/sonar-scala-docker/blob/master/2.3.0/Dockerfile), [(v2.3.0)](https://github.com/mwz/sonar-scala-docker/releases/tag/2.3.0) +- `2.3.0-full` [Dockerfile](https://github.com/mwz/sonar-scala-docker/blob/master/2.3.0-full/Dockerfile), [(v2.3.0)](https://github.com/mwz/sonar-scala-docker/releases/tag/2.3.0) +- `2.2.1`, [Dockerfile](https://github.com/mwz/sonar-scala-docker/blob/master/2.2.1/Dockerfile), [(v2.2.1)](https://github.com/mwz/sonar-scala-docker/releases/tag/2.2.1) - `2.2.1-full` [Dockerfile](https://github.com/mwz/sonar-scala-docker/blob/master/2.2.1-full/Dockerfile), [(v2.2.1)](https://github.com/mwz/sonar-scala-docker/releases/tag/2.2.1) - `2.2.0` [Dockerfile](https://github.com/mwz/sonar-scala-docker/blob/master/2.2.0/Dockerfile), [(v2.2.0)](https://github.com/mwz/sonar-scala-docker/releases/tag/2.2.0) - `2.2.0-full` [Dockerfile](https://github.com/mwz/sonar-scala-docker/blob/master/2.2.0-full/Dockerfile), [(v2.2.0)](https://github.com/mwz/sonar-scala-docker/releases/tag/2.2.0) - `2.1.0` [Dockerfile](https://github.com/mwz/sonar-scala-docker/blob/master/2.1.0/Dockerfile), [(v2.1.0)](https://github.com/mwz/sonar-scala-docker/releases/tag/2.1.0) - `2.1.0-full` ([Dockerfile](https://github.com/mwz/sonar-scala-docker/blob/master/2.1.0-full/Dockerfile)), [(v2.1.0)](https://github.com/mwz/sonar-scala-docker/releases/tag/2.1.0) +## What's included +Version | SonarQube | sonar-scala | sonar-scala-extra +--------|-----------|-------------|------------------ +2.3.0 | | 6.2.0 | 1.3.0 +2.3.0-full | 6.7.3 LTS | 6.2.0 | 1.3.0 +2.2.1 | | 6.1.0 | 1.3.0 +2.2.1-full | 6.7.3 LTS | 6.1.0 | 1.3.0 +2.2.0 | | 6.1.0 | 1.3.0 +2.2.0-full | 6.7.2 LTS | 6.1.0 | 1.3.0 +2.1.0 | | 6.0.0 | 1.3.0 +2.1.0-full | 6.7.1 LTS | 6.0.0 | 1.3.0 + + +## Usage +To use one of the volume images, mount it as a volume to your existing SonarQube container using e.g. `docker-compose`: +``` +version: "2" + +services: + sonarqube: + image: sonarqube:6.7.3-alpine # lts + ports: + - "80:9000" + networks: + - sonarnet + volumes: + - sonarqube_bundled-plugins:/opt/sonarqube/lib/bundled-plugins + volumes_from: + - plugins + + plugins: + image: mwizner/sonarqube-scala-plugins:2.3.0 + volumes: + - sonarqube_plugins:/opt/sonarqube/extensions/plugins + command: /bin/true + + ... +``` + +You can get the full recipe from [here](https://github.com/mwz/sonar-scala-docker/blob/master/docker-compose.yml). + +To use the `full` image, run the following `docker` command: +```bash +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:2.3.0-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. + ## Repository This project is open-sourced and can be found on [Github](https://github.com/mwz/sonar-scala-docker).