GitHub integration
As a Student
I want to integrate a GitHub repository with an instance of FyndR
So that I can upload my learning stories on my GitHub page
Extra Description
To allow students to publish their user stories with ease we want them to be able to create issues within their repository which can be uploaded to FyndR directly. In order to make it easy to setup we want as little steps as possible so that this process can be repeated multiple times with ease.
Acceptation criteria
Backend:
-
Integration tests succeed -
Endpoint for communication between GitHub and FyndR (requests must be authenticated using a secure token generated by our backend) -
Endpoint for creating a secure token -
Only admins can create secure tokens -
Tokens can be regenerated. This will remove the previous token from the database -
Learning stories can be posted, modified and removed from GitHub
Front-end:
-
Admins can manage the webhooks and their tokens under the manage tab on FyndR -
Admins can regenerate secure tokens -
Display author of the learning story inside the item -
Admins can view logs on repositories in case something doesn't seem to work
Database:
-
Add table GitHubTokens - Containing columns:
-
repositoryUrl -
token -
Depending on the type of token, maybe add expiration date
-
-
Add table for Connection between FyndR items and GitHub issues -
GitHub Issue ID -
FyndR Item ID
-
Research:
-
What type of secure token should we use? maybe JWT? -
How do integration tests work?
Edited by Tim Verkleij