Visualize workflow

Signed-off-by: Steven Kriegler <61625851+justusbunsi@users.noreply.github.com>
This commit is contained in:
justusbunsi 2021-05-24 19:54:06 +02:00
parent 0bee87ab08
commit 4cb2138451
No known key found for this signature in database
GPG key ID: 990B348ECAC9C7DB
3 changed files with 7 additions and 7 deletions

View file

@ -2,17 +2,17 @@
_Gitea SonarQube PR Bot_ is (obviously) a bot that receives messages from both SonarQube and Gitea to help developers
being productive. The idea behind this project is the missing ALM integration of Gitea in SonarQube. Unfortunately,
this won't be added in near future. _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.
this [won't be added in near future](https://github.com/SonarSource/sonarqube/pull/3248#issuecomment-701334327).
_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.
## Workflow
[add workflow schema]
![Workflow](assets/workflow.png)
**Insights**
- On PR create/PR push update; bot sets sonarqube status check to pending
- Some tool analyses code and sends it to SonarQube; it does not matter whether this tool waits for the results
- Webhook in SonarQube is sent to SonarQube/Gitea bot
- Bot activities
- extract data from SonarQube
- Read payload from hook post to receive project,branch/pr,quality-gate
@ -26,7 +26,6 @@ being notified on quality changes. Luckily, both endpoints have a proper REST AP
-> updates comment (/repos/{owner}/{repo}/issues/comments/{id})
-> updates status check (either failing/success)
## Authentication
- Gitea

1
assets/workflow.drawio Normal file
View file

@ -0,0 +1 @@
<mxfile host="app.diagrams.net" modified="2021-05-24T17:47:02.238Z" agent="5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/90.0.4430.212 Safari/537.36" etag="k-4EXQBDoI4jr22mGPE_" version="14.7.0" type="device"><diagram id="XhABa4TpQoJToBZdQaZ8" name="Page-1">zVtbd9soEP41Pif7EB/Q3Y+5NG13t2ezzW7bfcQStmhl4SKUxP31CxayBMiyYyuO/RDDcJFhvvlmGJSRe7N4fs/QMv1EE5yNHJA8j9zbkePAIHTFl5SsKknkwUowZyRRnRrBA/mFlRAoaUkSXGgdOaUZJ0tdGNM8xzHXZIgx+qR3m9FMf+oSzbEleIhRZku/koSnahVO2Mg/YDJP6yfDYFK1LFDdWa2kSFFCn1oi993IvWGU8qq0eL7Bmdy8el+qcXdbWjc/jOGc7zPgw1/s++Lh9+nXf4q/sj+ijyT6klw6QTXNI8pKtWL1a/mq3oKnlHD8sESxrD8JNY/c65QvMlGDooiKZbXxM/KMxbOuGS3zRJZugahtli0r8wwVhSonqEjXveQkxQ/M41S1zGjOb2hG2fr5Llh/5GiGEoKbtpzmWI7ljP7AhlAtCzOOn7duGNyoQeAX0wXmbCW6qAGeUpxCbq3HpwYGQaRkaQsCGyFS0JtvZm60IwpKQS9QFowsZV0Ev42cIBOPvp4yUZrL0lWS2ELx/bOkVemu+Hk5FWUHMPxI8FO7zRwX08VCbpi0O/Hn/rOFD5wIi1FVynhK5zRH2btGaiKi1rVUfDPgT0qXSvgdc75SXIBK8VwNcOLXsNU3Odk48sJa8J9sHQPXrQW3z+p5VW3Vrt1jRoROMKsRR7KsE0BybQfCB4wdVwPQpaf0x3CGOHnUJ+5Ci5r7npK1AmpcOjowA2AArqAli7Ea1WYEcyIfjgMPbD5Qm9YHcDyJ9Jk5YnPMrZmvGEOrVrel7FD0rMB3OlfQGEc1ozG6np7OZgXmI9OcNio4wsJc28LcDgv7jGMsFWg1POFpSumPjgYiSMOSIoH7VUEKu4XhosyqPTwXY3P8tq2BHXbWNilB4jMkeBFYbC1abkLXX7fsa3FiP9YA79GjpyKFNVz79N1twbXBuuAQg32pNbihbs/QNRz5y/q/nfV4lvE8CKyxv8sptnCso3RHiKGB2ADWFCbJrBNYEITuZKBYwDWCAc8OBqDTFQy8Wizg7A7cDuYKcCxXaEQx9g+kCi1CxM+Ef2umE7UNC4lyM7Os1BMPyCj+nozi7YgJQOTqUQE8CcdAI2YIz4QyfAvFNx9FfVoScU4TalkVHC8GIg8LUgPwQmBQcfTmvADPmRfGWggBh+CFAW082NPG/V5IXIpVQqAHuIcZ+UkjX9sSL5xBIt+Z0F91bgQdp0uGEcfrpjvxt1wm6+q5BL1wNIgjO0nMuy96+wlNoBf4UaSh99I7iY/yXSPGCvvjYLP/2Tg1O6f2XngoNGAMbAEKgOiqBahhY903D3Y78l6wg5skx+wgmGVZpEfTywGM0neC2dDE1rP2Lkc5IIuEe7JIsCvODetEuHFiOjL5tXGldZbKM0A3UIrKPGQHykG+ObnAiW0MfqejVpld0yBSlM9xUVuE2fyJJmQmN4oURdnh5guOeHlGaSk4BkDLAYOxO/EOyQGLlTF+Ja+MRq2rBSG7I1JDamBS94jlVQaJK6HqsoWa1fXFG1hp/2lU+PoQhoar90/h6oN+69rd3zsPYwwtW7zFjzijS4Eq00SKFC1lsVxkVzGX6LiWbprEAvZoirN7WhBOaC66TCnndNHqcJWRuWzg1IgKaMkzkgu41beflnENERBEvs65db0VELgnPeQCa9+/WPs9F4yztAKnbbeR2+4ct26funBG0/p54Ng46wySita2qsAVtBK51VHumnJrxxuKhy9My1ikOfUCH3hdsVISonhfWPeAx9bKm+26Y+fNL6IOj/4xEQtbO2ezpbrLlTe1KE+EEC3kZufTYjnqutIlueqNc1uJp/bkr+V2N0fsVlQdDnKDtYcf72Wtnd69fs/lwJP8/sH0RCegy1eKpaGZJe0/15vdL3fch5mr2O86rB6su7ZNHuwEgbydJrgIB864bX2Z41zCdzCeQC18l/knEB0Sv28/VScGvTTMYcX9Db20OaifYPbgg33j+n0tf+fpG7iBhuvT3GR7vm6KdYSz/QWU3v5vF9c7diR0Memwzbu1GQhnWrK1sjtTUiDBHJHsjA7NL7yH2dNCjvLSRzjboY1r1xUu9Bw9tXVgfvykgHbOCX0ve5Po1SPEM8LeFmI/7QtIu2h7R3+dtgdDcMerefKCUiX2L7xWGYIOrv5X3S1uy2iCOMVxRzQ1cjqOUGte74um1ikd3QCQSuLEYgxup3/q7M6CJElleLggv1RmQQJRKVBM7l+P/Ntj0xI9DNGXK3QmBu/B41ivnrn+j4A6DWLMcAgpimrzYn3Vvfn3BPfd/w==</diagram></mxfile>

BIN
assets/workflow.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 77 KiB