OpenFn / OpenFn/lightning

Better error handling and status tracking for GitHub actions

Open
#2,462 6 comments 0 reactions 1 assignee View on GitHub

@midigofrank is already working on this.

Since Nov 22, 2024.

Feedback ux/ui improvement
Dominant language
Elixir
Stars
296
Forks
86
Avg merge
1d 13h
Merged PRs (30d)
50

Description

Our current design of the GitHub sync is such that when a user triggers the sync there is no way for them to know if it is successful. When this is successful, it is great but when there is an error and the sync is not successful, it can be catastrophic.

When a sync operation fails, we should trigger the failure alert as well so that they receive an email that it failed. In the future, we should allow them to see a list of GitHub syncs on their projects and the status of those operations.

Notify users when GitHub sync failure

  • OpenFn -> GitHub
    • Alert the user who initiated the sync about the failure
  • GitHub -> OpenFn
    • Alert the users on the project that a sync from GitHub to OpenFn has failed. This should be treated as a failure alert and ONLY users that enabled failure alerts should be notified.

Show users the last time a project synced on the project list page

  • We are adding a new field named Latest sync to the projects table (in the db) and it should store the last time a project was synced to GitHub.
  • Add a Latest Sync date field to the project list table to show the last time the project was synced. (In the future we want to allow users to sync their projects wherever they like – bitbucket, GitLab, S3 bucket, or any other storage service)
    Please do not remove the last updated field.

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.