Infrastructure/toddlers
1
0
Fork 0
Code Issues 10 Pull requests 1 Projects Releases Packages Wiki Activity Actions

Add documentation for scm_request_processor

Browse source 
Add simple markdown file and flowchart diagram in SVG format.

Signed-off-by: Michal Konečný <mkonecny@redhat.com>
This commit is contained in:
Michal Konečný 2022-03-25 16:23:44 +01:00
parent 5cc824a7f4
commit 4cad77ca4c
2 changed files with 19 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

15
docs/scm_request_processor.md Normal file
View file

@ -0,0 +1,15 @@
# SCM Request Processor
SCM Request processor is toddler created from https://pagure.io/fedscm-admin/ script. It process tickets on https://pagure.io/releng/fedora-scm-requests/ , validates them and creates the branch or repository if everything is OK.
## Accepted topics
The SCM Request processor accepts few topics emitted by pagure. These topics allows it to process any newly created ticket or react to any ticket that is updated or commented on.
* org.fedoraproject.*.pagure.issue.new - New issue on pagure created
* org.fedoraproject.*.pagure.issue.edit - Issue on pagure is edited
* org.fedoraporject.*.pagure.issue.comment.added - New comment is added to issue
## Flowchart diagram
[Flowchart diagram](./scm_request_processor.png) illustrates the code flow of the SCM Request Processor, what is being validated and what reaction is done if the validation fails.