1b7c3a0c6b
After feedback from stakeholders update the conclusion of this investigation. Signed-off-by: Michal Konečný <mkonecny@redhat.com>
75 lines
1.9 KiB
ReStructuredText
75 lines
1.9 KiB
ReStructuredText
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
|
|
enhancing_the_development_environment
|
|
|
|
|
|
Conclusions
|
|
-----------
|
|
|
|
Investigation team recommends to not work on this app, but instead work
|
|
on :ref:`../webhook2fedmsg/index`.
|
|
|
|
Proposed Roadmap
|
|
----------------
|
|
|
|
See :ref:`../webhook2fedmsg/index:Proposed Roadmap`.
|
|
|
|
Estimate of work
|
|
----------------
|
|
|
|
See :ref:`../webhook2fedmsg/index:Estimate of work`.
|