OpenFn / OpenFn/lightning

Show and alert users when Github Sync fails

Open
#2,965 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Elixir
Stars
296
Forks
86
Avg merge
1d 13h
Merged PRs (30d)
50

Description

When GitHub sync fails, project users don't know without checking GitHub. This can be cumbersome especially when they are actively devving on the Lightning. We want to notify users in the app and via failure alerts when a GitHub Sync operation fails.

Users can be at risk of losing their work and having failed runs due to a failed Sync and other downstream issues that could arise from it.

OpenFn -> GitHub Syncs
I would also love to be able to view the list of syncs I have attempted in my project on the GitHub sync page.
Image

This can also be extended as an icon that shows the status of the latest OpenFn -> GitHub Sync for a project on the nav bar or somewhere prominent for users. This ensures that users are aware when a filed sync occurs without having to leave the app and no data is lost because of a failed sync.

For GitHub -> OpenFn Syncs
We should also alert the users on the project that a sync from GitHub to OpenFn has failed. We should treat this like the existing failure alert and ONLY users that enabled failure alerts should be notified.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing failure-alert behavior and the GitHub sync page, including both OpenFn-to-GitHub and GitHub-to-OpenFn flows. Done should include visible failed-sync status, a history of attempted syncs, and failure notifications limited to users who enabled failure alerts.

Written by the indexing model from the issue text.

Assessment

Tech stack
elixir, github
Domain
backend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.