Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Comments UX improvements #1071

Merged
merged 44 commits into from
Jan 25, 2024
Merged

Comments UX improvements #1071

merged 44 commits into from
Jan 25, 2024

Conversation

motatoes
Copy link
Contributor

@motatoes motatoes commented Jan 18, 2024

What is this change

Improvements to the backend reporting to add a comment as soon as a webhook is received and this comment will contain a summary of progress. The backend adds the initial comment and it is update by the cli job everytime a job execution completes

Changes introduced by this PR:

  • Introduction of a CommentReporter struct to initialize initial comment and keep updating it by backend
  • Introduction of DiggerJobSummary to store the list of resources updated, created, deleted by a job and can also contain more items in the future
  • Moving shared scheduler models to lib-orchestrator to be shared by both cli and backend
  • Modify the set-status endpoint to return the summary of all jobs after it is called
  • Modify the cli to report the job plan summary (resources changed) after every change
  • Modify the cli to update the comment posted by backend after every job is completed to update it with the summary
  • Breaking change: Workflow file now accepts a comment_id parameter and needs to be modified accordingly

@ZIJ ZIJ changed the title Feat/comments ux improvments [WIP] Comments UX improvments Jan 24, 2024
@motatoes motatoes changed the title [WIP] Comments UX improvments Comments UX improvements Jan 25, 2024
@ZIJ ZIJ merged commit acc9e2f into develop Jan 25, 2024
4 checks passed
ben-of-codecraft pushed a commit to ben-of-codecraft/digger that referenced this pull request May 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants