From c114d8ee0f7e3437e2f8f4ac5c9ca85aaebcd5ed Mon Sep 17 00:00:00 2001 From: justusbunsi <61625851+justusbunsi@users.noreply.github.com> Date: Sat, 9 Oct 2021 20:46:12 +0200 Subject: [PATCH] Care about documentation Signed-off-by: Steven Kriegler <61625851+justusbunsi@users.noreply.github.com> --- CONTRIBUTING.md | 2 +- README.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3fda7be..cc175e2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -15,7 +15,7 @@ docker build -t gitea-sonarqube-pr-bot/dev -f contrib/Dockerfile contrib # Start the environment -docker run --rm -it -p 9100:8080 -v "$(pwd):/projects" gitea-sonarqube-pr-bot/dev +docker run --rm -it -p 49182:8080 -v "$(pwd):/projects" gitea-sonarqube-pr-bot/dev # Build the binary go build ./cmd/gitea-sonarqube-bot diff --git a/README.md b/README.md index 6d22846..30171d9 100644 --- a/README.md +++ b/README.md @@ -6,8 +6,6 @@ this [won't be added in near future](https://github.com/SonarSource/sonarqube/pu _Gitea SonarQube PR Bot_ aims to fill the gap between working on pull requests and being notified on quality changes. 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) @@ -19,6 +17,8 @@ Luckily, both endpoints have a proper REST API to communicate with each others. ## TODOs - [ ] Validate configuration on startup +- [ ] Verify webhook secrets +- [ ] Only post status-check (Opt-in/out) - [ ] 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