Add GitHub integration notes about zally HOT 6 CLOSED

Notes were added, Github integration itself is postponed until next quarter. I close this issue for now.

from zally.

@Nagogus @mkulak Can you add your notes first? Based on this we can write documentation and see what needs to be implemented further.

from zally.

@fmueller first we need to implement authentication interface, so we can get github token. Currently token is hardcoded.

from zally.

Maybe it can be another task then?

from zally.

Currently GH integration works this way:

• We registered web-hook in test repo on actions "PR created" and "commit"
• There is special endpoint /github-hook in GithubController which is called by github on each PR/commit in test repo. (see docs)
• When callback from GH is received we set status of corresponding PR to pending. Then download content of swagger file from this PR and validate it. If there are MUST violations we set status of this PR to failed (which means that PR cannot be merged). Otherwise we set status to success.

Notes on current implementation:

• All requests are executed synchronously (set pending -> get content -> set success/failed)
• User need to setup webhook manually (Zappr does this automatically)
• In order to access file content we need to get token for this repo. For now it's hardcoded (same thing).
• Path to swagger file is hardcoded to swagger/swagger.yaml (perhaps there will be option to specify this path in Zally's frontend)
• Status for PR is called "commit status" in GH parlance.

from zally.

@mkulak thanks for the notes. Also linking to #83, might be helpful.

from zally.