Skip to content

feat: template notifications #16

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

Closed
1 of 2 tasks
dannykopping opened this issue Jul 18, 2024 · 12 comments · Fixed by coder/coder#14419
Closed
1 of 2 tasks

feat: template notifications #16

dannykopping opened this issue Jul 18, 2024 · 12 comments · Fixed by coder/coder#14419

Comments

@dannykopping
Copy link
Collaborator

dannykopping commented Jul 18, 2024

Creating system-generated notifications for key template events. These are mainly targeted towards template administrators.

Relates to coder/coder#13328

Create notification_template instances for the following events, and enqueue notifications with those templates:

automatic build failure (receiver: template admin)
> When an automatic workspace build fails, the template administrators should know so they may investigate issues with the template. will be covered by #40

  • template deleted (receiver: template admin)

    When a template is deleted, the template administrators should be alerted of the successful operation. Particularly helpful when another admin deletes a template they did not create.

@dannykopping dannykopping changed the title Implement template notifications Template notifications Jul 18, 2024
@dannykopping dannykopping changed the title Template notifications feat: template notifications Jul 18, 2024
@johnstcn
Copy link
Member

johnstcn commented Aug 8, 2024

@dannykopping is this already done?

@dannykopping
Copy link
Collaborator Author

Nope.

@stirby
Copy link

stirby commented Aug 8, 2024

@dannykopping Is this tracking "Notification templates" for "Template events" or "Workspace Events"?

@dannykopping
Copy link
Collaborator Author

@stirby it's kinda both since they're related, although admittedly these items could have certainly used some more description.

Template admins should receive a notification when a member tries to build a workspace and the template fails for whatever reason, for example.

@BrunoQuaresma
Copy link

BrunoQuaresma commented Aug 13, 2024

@stirby @dannykopping for the "manual build failure" notification I'm thinking of using the following copy:

Hi <username>,

The workspace <workspace-name>, using the template <template-name>, failed during a manual build for the <transition> initiated by the user <username>.

[View Build]

Wdyt?

@BrunoQuaresma
Copy link

I see we want to notify the "manual build failure" to the owner, but it is unclear if the owner is the template owner or owner role. The same for "automatic build failure" referencing the "template admin".

cc.: @stirby @dannykopping

@stirby
Copy link

stirby commented Aug 15, 2024

The manual build failures should be sent to all template admins in the org. I don't think we need to send it to the owner role.

@stirby
Copy link

stirby commented Aug 15, 2024

@dannykopping I added context to the issue description. I think this is good to move to coder/coder.

@mtojek mtojek self-assigned this Aug 22, 2024
@mtojek
Copy link
Member

mtojek commented Aug 22, 2024

I'm looking into this now, and I'd like to clarify a few things, @dannykopping.

Re automatic build failed:
Coder can send the following notification: Workspace "workspaceworkspaceworkspaceworks" autobuild failed to workspace owners. Does it mean we just want to dispatch similar notifications to template admins?

Re manual build failure:
The action item mentions workspace owner, but the description template admin. Which one is expected?

@dannykopping
Copy link
Collaborator Author

dannykopping commented Aug 23, 2024

Re automatic build failed:
Coder can send the following notification: Workspace "workspaceworkspaceworkspaceworks" autobuild failed to workspace owners. Does it mean we just want to dispatch similar notifications to template admins?

I'm concerned that in an org of 100 users if an autobuild fails for everyone at the same time that template admins will have their inboxes flooded. If we can send them a summary email once a day that shows how many autobuilds failed, that might be more practical.

Re manual build failure:
The action item mentions workspace owner, but the description template admin. Which one is expected?

See @stirby's position here, which I agree with: #16 (comment)
As above - I think this could get noisy, though.

@mtojek
Copy link
Member

mtojek commented Aug 23, 2024

If we can send them a summary email once a day that shows how many autobuilds failed, that might be more practical.

I agree with the risk of flooding users, so this looks to me as a separate mini-RFC that Coder is able to send daily operational stats. WDYT?

See @stirby's position here, which I agree with
The manual build failures should be sent to all template admins in the org. I don't think we need to send it to the owner role.

ACK 👍 I will see what I can do with: coder/coder#14262

@dannykopping
Copy link
Collaborator Author

I agree with the risk of flooding users, so this looks to me as a separate mini-RFC that Coder is able to send daily operational stats. WDYT?

Interesting idea, I like it!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants