Improve GitHub Sync Experience

Improve Github Sync Experience

Goals:

1. Improve the developer experience for GH Sync
2. Don’t overwrite unsynced changes

KPI: Improve Consultant NPS

Problem/Observation:

Some issues have been reported concerning GitHub Sync recently that hamper the experience of consultants on the application:

1. Users don’t know when a GitHub sync fails until they check GitHub actions
2. When deploying local changes to a GitHub profile, we trigger a Sync that overwrites all unsynced changes on app.openfn.org.
3. We cannot trust users to always sync their changes to GitHub
4. Updating random non-openfn files automatically triggers a sync:
5. Aleksa recently mistakenly overwrote a project with old changes because she was trying to update the readme file of a repo.

Constraints (time/budget/product/)

N/A

Assumptions:

N/A

What to be done:

• Alert a user when sync breaks
  We want users to know when GitHub sync fails via an email and a log list of syncs showing on the version control page.
• Only OpenFn related files should trigger a sync. #2821
  GitHub to OpenFn sync should not be triggered because I updated the readme of my GitHub repo
• 3. Allow users to set up auto-sync to GitHub for their projects. This makes it so that a project automatically syncs to GitHub every X minutes and reduces the risk of overwriting changes.
• Allow users to set a prompt for GitHub Sync after X number of saves. If this is set, a user will be able to say after every 5 saves.

I want to be able to sync to GitHub so that I don’t lose my data.
Save 1….4 = normal Save 
Save 5 = trigger Save and Sync and loads modal for commit and reset save count.

• Allow users to see the list of a project’s GitHub Syncs and their final state in the version control page. https://github.com/OpenFn/lightning/issues/2965
• Show project collaborators when they have unsynced changes
• Other issues/bugs reported :
  a. #1864
  b. #2966