Skip to content

Commit

Permalink
README.md update for docker process
Browse files Browse the repository at this point in the history
  • Loading branch information
dedece35 committed Jan 4, 2024
1 parent 64ca2ce commit 7b66d75
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 1 deletion.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- [#7](https://github.com/green-code-initiative/ecoCode-python/issues/7) Add build number to manifest
- [#123](https://github.com/green-code-initiative/ecoCode/issues/123) Improve unit tests for EC7 rule
- Update ecocode-rules-specifications to 1.4.6
- README.md upgrade : docker test environment

### Deleted

Expand Down
28 changes: 27 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,33 @@ the [ecoCode repository](https://github.com/green-code-initiative/ecoCode#-sonar
🚀 Getting Started
------------------

check [ecoCode repository](https://github.com/green-code-initiative/ecoCode#-getting-started)
You can give a try with a one command docker :

```sh
docker run -ti --rm \
-p 9000:9000 \
--name sonarqube-ecocode-python ghcr.io/green-code-initiative/sonarqube-ecocode-python:latest
```

or (with logs and data locally stored) :

```sh
docker run -ti --rm \
-v sq_ecocode_logs:/opt/sonarqube/logs \
-v sq_ecocode_data:/opt/sonarqube/data \
-p 9000:9000 \
--name sonarqube-ecocode-python ghcr.io/green-code-initiative/sonarqube-ecocode-python:latest
```

... and configure local SonarQube (security config and quality profile : see [configuration](https://github.com/green-code-initiative/ecoCode-common/blob/main/doc/INSTALL.md#configuration-sonarqube) for more details).

To install other `ecocode` plugins, you can also :
- download each plugin separatly and copy the plugin (jar file) to `$SONAR_INSTALL_DIR/extensions/plugins` and restart SonarQube.
- install different ecocode plugins with Marketplace (inside admin panel of SonarQube)

Then you can use Python test project repository to test the environment : see README.md of [Python test project](https://github.com/green-code-initiative/ecoCode-python-test-project)

Finally, you can directly use a [all-in-one docker-compose](https://github.com/green-code-initiative/ecoCode-common/blob/main/doc/INSTALL.md#start-sonarqube-if-first-time)

🛒 Distribution
------------------
Expand Down

0 comments on commit 7b66d75

Please sign in to comment.