From b8c86aaab8d2e98a0d3e8db7daf72aef30896fe6 Mon Sep 17 00:00:00 2001 From: justusbunsi <61625851+justusbunsi@users.noreply.github.com> Date: Mon, 11 Oct 2021 17:39:21 +0200 Subject: [PATCH] Update docs Signed-off-by: Steven Kriegler <61625851+justusbunsi@users.noreply.github.com> --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8db4fc6..e803fd7 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,7 @@ Luckily, both endpoints have a proper REST API to communicate with each others. - [Gitea SonarQube PR Bot](#gitea-sonarqube-pr-bot) - [Workflow](#workflow) + - [Requirements](#requirements) - [Setup](#setup) - [Bot configuration](#bot-configuration) - [Contributing](#contributing) @@ -31,6 +32,10 @@ Luckily, both endpoints have a proper REST API to communicate with each others. - [x] comment PR in Gitea (/repos/{owner}/{repo}/issues/{index}/comments) - [x] updates status check (either failing/success) +## Requirements + +This bot is designed to interact with [SonarQube _Developer_ edition](https://www.sonarsource.com/plans-and-pricing/) and above due to its pull request features. It will most likely work with public SonarCloud because it includes that feature for open source projects. + ## Setup **SonarQube** @@ -72,8 +77,8 @@ NOTES: - [ ] Configuration live reloading - [ ] _Caching_ of outgoing requests in case the target is not available - [ ] Parsable logging for monitoring -- [ ] Official image for containerized hosting -- [ ] Helm chart for Kubernetes +- [x] Official image for containerized hosting +- [x] Helm chart for Kubernetes ### Possible improvements