Initial template for github2fedmsg investigation
This is initial template for github2fedmsg investigation, it contains 3 scenarios ARC team will investigate. Signed-off-by: Michal Konečný <mkonecny@redhat.com>
This commit is contained in:
parent
ccca00e872
commit
79c968fa71
6 changed files with 173 additions and 0 deletions
77
docs/github2fedmsg/index.rst
Normal file
77
docs/github2fedmsg/index.rst
Normal file
|
@ -0,0 +1,77 @@
|
|||
github2fedmsg
|
||||
=============
|
||||
|
||||
Purpose
|
||||
-------
|
||||
|
||||
This investigation's goal is to address tech debt of github2fedmsg application.
|
||||
github2fedmsg application is used to translate events emitted by github to fedora messaging
|
||||
messages using github webhooks. It also has database of projects to watch and provides web
|
||||
interface to add new repositories. It authenticates with FAS and Github, linking accounts
|
||||
together.
|
||||
|
||||
The app has git-hub2fedmsg bot on GitHub that is being used to link the FAS account to
|
||||
Github.
|
||||
|
||||
Resources
|
||||
---------
|
||||
|
||||
* github2fedmsg initiative proposal: https://pagure.io/cpe/initiatives-proposal/issue/24
|
||||
* github2fedmsg repo: https://github.com/fedora-infra/github2fedmsg
|
||||
* github2fedmsg web: https://apps.fedoraproject.org/github2fedmsg
|
||||
* github2fedmsg ansible: https://pagure.io/fedora-infra/ansible/blob/main/f/roles/github2fedmsg
|
||||
* github2fedmsg SOP: https://docs.fedoraproject.org/en-US/infra/sysadmin_guide/github2fedmsg/
|
||||
|
||||
Requirements
|
||||
------------
|
||||
|
||||
* Porting to Flask and authlib
|
||||
* Linking GitHub account to FAS account
|
||||
* Listening to GitHub events
|
||||
* Translating GitHub events to Fedora messages
|
||||
* Add/remove repositories to watch
|
||||
* CI
|
||||
* Documentation
|
||||
* OpenShift deployment
|
||||
|
||||
|
||||
What Needs To Be Addressed?
|
||||
---------------------------
|
||||
|
||||
* Create message schema
|
||||
* python2 -> python3
|
||||
* migration to OpenShift
|
||||
* Documentation - only README and SOPs are available
|
||||
* Update development environment
|
||||
* There is no staging environment
|
||||
|
||||
Investigation
|
||||
-------------
|
||||
|
||||
Here is the list of ideas/things we discussed/looked at:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
revitalization
|
||||
rewrite
|
||||
webhook2fedmsg
|
||||
enhancement_of_repository
|
||||
|
||||
|
||||
Conclusions
|
||||
-----------
|
||||
|
||||
The best approach would be bla bla bla...
|
||||
|
||||
Proposed Roadmap
|
||||
----------------
|
||||
|
||||
* Step 1 - Make github2fedmsg great again!
|
||||
* Step 2 - ???
|
||||
* Step 3 - Profit!
|
||||
|
||||
Estimate of work
|
||||
----------------
|
||||
|
||||
It will take as much time as needed.
|
Loading…
Add table
Add a link
Reference in a new issue