From e42c671689394ccce44e77fa56c935a186712775 Mon Sep 17 00:00:00 2001 From: justusbunsi <61625851+justusbunsi@users.noreply.github.com> Date: Thu, 24 Jun 2021 10:52:14 +0200 Subject: [PATCH] Document TODOs Signed-off-by: Steven Kriegler <61625851+justusbunsi@users.noreply.github.com> --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index cbd7ae9..4ae98ab 100644 --- a/README.md +++ b/README.md @@ -9,12 +9,23 @@ Luckily, both endpoints have a proper REST API to communicate with each others. ## Table of Contents - [Gitea SonarQube PR Bot](#gitea-sonarqube-pr-bot) + - [TODOs](#todos) - [Workflow](#workflow) - [Setup](#setup) - [Bot configuration](#bot-configuration) - [Contributing](#contributing) - [License](#license) +## TODOs + +- [ ] Maybe drop `PRBOT_CONFIG_PATH` environment variable in favor of `--config path/to/config.yaml` cli attribute +- [ ] Configure SonarQube PR branch naming pattern for more flexibility (currently focused on Jenkins with [Gitea Plugin](https://github.com/jenkinsci/gitea-plugin)) +- [ ] 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 + ## Workflow ![Workflow](docs/workflow.png)