[MM-356] Add feature to subscribe to release and workflow events #765

ayusht2810 · 2024-04-08T13:31:58Z

Summary

Added feature to publish workflow failure events

Screenshot

Ticket Link

Fixes #722
Fixes #565

What to test?

Update the webhook for the repo to receive notifications for workflow events
Create a subscription for a repo with a subscription enabled for workflow events
Create workflow in which a particular jobs fail
Check for the event received in the subscribed channel

Checklist

Completed dev testing
make test Ran test cases and ensured they are passing
make check-style Ran style check and ensured both webapp and server pass the checks

mickmister · 2024-04-23T20:44:25Z

server/plugin/webhook.go

+	for _, sub := range subs {
+		if !sub.Workflows() {
+			continue
+		}


1/5 I think we should support (or require) a workflow parameter here (and maybe support job parameter as well). Maybe we can support both individual workflows and all workflow cases:

Just the ci workflow

/github subscriptions add owner/repo pulls,workflows:ci,issues

All workflows

/github subscriptions add owner/repo pulls,workflows:*,issues

@hanzei What do you think?

Makes sense to me 👍

Limiting the notifications to a specific branch seems like a common use case. Can we include that in there as well?

Just the ci workflow

@mickmister Are you suggesting here to add a subscription on the basis of the workflow name, which is ci in the above case, or have I misunderstood the comment?

Limiting the notifications to a specific branch seems like a common use case. Can we include that in there as well?

@mickmister @hanzei For the above case, what should be the slash command format? Should we keep something like: /github subscriptions add owner/repo pulls,workflows:branch-b1,b2;name-n1,n2;job-j1,j2? Please let me know if you have any better suggestions for the above case.

The subscriptions add feature is quite overloaded at this point. Adding more complexity on top of it may not be the best thing to do. Created a ticket for breaking this out of the command #780

Mainly thinking of the complexity of the job parameter there. I'm thinking we should avoid the job parameter, since those jobs may not belong to all workflows. Then it's up to the actions workflow developer in that project to structure the workflows in a way to be something to subscribe to.

server/plugin/template.go

hanzei · 2024-04-30T10:13:53Z

README.md

@@ -150,7 +150,7 @@ When you’ve tested the plugin and confirmed it’s working, notify your team s
   /github subscriptions add mattermost/mattermost-server --features issues,pulls,issue_comments,label:"Help Wanted"
   ```
  - The following flags are supported:
-     - `--features`: comma-delimited list of one or more of: issues, pulls, pulls_merged, pulls_created, pushes, creates, deletes, issue_creations, issue_comments, pull_reviews, label:"labelname". Defaults to pulls,issues,creates,deletes.
+     - `--features`: comma-delimited list of one or more of: issues, pulls, pulls_merged, pulls_created, pushes, creates, deletes, issue_creations, issue_comments, pull_reviews, workflows, label:"labelname". Defaults to pulls,issues,creates,deletes.


I wonder if we should rename the flag to workflow-failures to make it clear that only these get notifications. Or add an option to workflows that specifies if only failed or also successful runs should trigger a notification.

Updated the flag to workflow-failures. Let me know if I should do the latter one.

I'm thinking we should have separate workflow-success and workflow-failure subscription types

@mickmister Added the workflow_success. Please have a look

@hanzei are you still requesting changes here?

Where did the README.md updates go?

@hanzei Since the plugin functionality details have been moved to mattermost docs repo, I have made a PR on it for the same

…emplate

…ub into MM-356

mickmister

@Kshitij-Katiyar Great job on this 👍 I have a few more comments

go.mod

server/plugin/command.go

webapp/package.json

mickmister · 2024-06-20T17:34:24Z

server/plugin/webhook.go

+		return
+	}
+
+	newReleaseMessage, err := renderTemplate("newReleaseEvent", event)


@phoinixgrr FYI this feature in the GitHub plugin will allow us to create subscriptions to new releases

server/plugin/template.go

Kshitij-Katiyar · 2024-06-25T11:54:07Z

@mickmister Fixed the comments, Please have a look.

…ub into MM-356

server/plugin/template_test.go

webapp/package-lock.json

…ed package-lock changes

wiggin77 · 2024-08-01T14:54:16Z

This PR is going to have a significant merge conflict with https://github.com/mattermost/mattermost-plugin-github/pull/808/files

Does anyone have an opinion on which is more important?: release and workflow subscriptions vs discussions and comment

raghavaggarwal2308 · 2024-08-06T09:52:22Z

@wiggin77 In both the PRs we mainly adding new functions not updating the existing functions much. I think it won't be difficult to fix the conflicts in this case. So, we can merge whichever PR is ready first. Please let me know your opinions on this.

wiggin77 · 2024-08-06T18:12:14Z

@wiggin77 In both the PRs we mainly adding new functions not updating the existing functions much. I think it won't be difficult to fix the conflicts in this case. So, we can merge whichever PR is ready first. Please let me know your opinions on this.

Ok, let's get this one merged first.

wiggin77

LGTM 👍

mattermost-build · 2024-09-22T01:02:36Z

This PR has been automatically labelled "stale" because it hasn't had recent activity.
A core team member will check in on the status of the PR to help with questions.
Thank you for your contribution!

…ub into MM-356

mattermost-build · 2024-10-08T01:02:49Z

This PR has been automatically labelled "stale" because it hasn't had recent activity.
A core team member will check in on the status of the PR to help with questions.
Thank you for your contribution!

arush-vashishtha

Tested this PR for both success and failure scenarios in the workflow and the user is receiving the message. LGTM.

ayusht2810 added 2 commits April 8, 2024 18:54

[MM-356] Add feature to publish workflow failure events

5dc7a26

[MM-356] Update webhook event name

e5c50fd

ayusht2810 requested review from hanzei and mickmister as code owners April 8, 2024 13:31

ayusht2810 requested a review from raghavaggarwal2308 April 8, 2024 13:32

ayusht2810 self-assigned this Apr 8, 2024

ayusht2810 added the 2: Dev Review Requires review by a core committer label Apr 8, 2024

mickmister reviewed Apr 23, 2024

View reviewed changes

hanzei requested changes Apr 30, 2024

View reviewed changes

ayusht2810 and others added 3 commits May 8, 2024 19:38

[MM-356] Update go-github package and included workflow name in the t…

ec69c2d

…emplate

Merge branch 'master' of github.com:mattermost/mattermost-plugin-gith…

32882a1

…ub into MM-356

[MM-356]: Added feature of workflow_success in subscription

28cdb5a

Kshitij-Katiyar requested a review from mickmister June 20, 2024 07:53

mickmister changed the title ~~[MM-356] Add feature to publish workflow failure events~~ [MM-356] Add feature to subscribe to release and workflow events Jun 20, 2024

mickmister reviewed Jun 20, 2024

View reviewed changes

Kshitij-Katiyar added 2 commits June 25, 2024 16:53

[MM-356]: added releases to subscription feature list

0d050ac

[MM-356]: fixed ci

612a259

Kshitij-Katiyar requested a review from mickmister June 25, 2024 11:51

mickmister approved these changes Jul 4, 2024

View reviewed changes

raghavaggarwal2308 requested review from AayushChaudhary0001 and wiggin77 July 4, 2024 09:02

wiggin77 requested review from hanzei and Kshitij-Katiyar July 12, 2024 17:51

raghavaggarwal2308 added 2 commits July 15, 2024 12:34

Merge branch 'master' of github.com:mattermost/mattermost-plugin-gith…

96ed032

…ub into MM-356

Updated package-lock file

ab37277

hanzei reviewed Jul 29, 2024

View reviewed changes

server/plugin/template_test.go Show resolved Hide resolved

webapp/package-lock.json Outdated Show resolved Hide resolved

Kshitij-Katiyar added 3 commits July 31, 2024 19:44

[MM-356]: Added success testcase for workflow notification and revert…

f9034c4

…ed package-lock changes

[MM-356]: reverted the package-lock changes

b629477

[MM-356]: minor updates in template_test.go file

e5385bc

Kshitij-Katiyar mentioned this pull request Aug 1, 2024

[MM-356]: Updated the readme for Github with added support for workflow subscription mattermost/docs#7310

Merged

Kshitij-Katiyar requested a review from hanzei August 1, 2024 12:52

hanzei approved these changes Aug 3, 2024

View reviewed changes

wiggin77 approved these changes Aug 6, 2024

View reviewed changes

wiggin77 added the 3: QA Review Requires review by a QA tester label Aug 6, 2024

mattermost-build added the Lifecycle/1:stale label Sep 22, 2024

Merge branch 'master' of github.com:mattermost/mattermost-plugin-gith…

9e536e7

…ub into MM-356

raghavaggarwal2308 removed 2: Dev Review Requires review by a core committer Lifecycle/1:stale labels Sep 27, 2024

mattermost-build added the Lifecycle/1:stale label Oct 8, 2024

arush-vashishtha approved these changes Nov 14, 2024

View reviewed changes

raghavaggarwal2308 merged commit 505e539 into master Nov 14, 2024
9 checks passed

raghavaggarwal2308 deleted the MM-356 branch November 14, 2024 08:04

hanzei added this to the v2.4.0 milestone Nov 14, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[MM-356] Add feature to subscribe to release and workflow events #765

[MM-356] Add feature to subscribe to release and workflow events #765

ayusht2810 commented Apr 8, 2024 •

edited by fmartingr

Loading

mickmister Apr 23, 2024

hanzei Apr 30, 2024

ayusht2810 May 1, 2024 •

edited

Loading

ayusht2810 May 8, 2024

mickmister May 13, 2024

hanzei Apr 30, 2024

ayusht2810 May 8, 2024

mickmister May 13, 2024

Kshitij-Katiyar Jun 20, 2024

wiggin77 Jul 26, 2024

hanzei Jul 29, 2024

Kshitij-Katiyar Aug 1, 2024

mickmister left a comment

mickmister Jun 20, 2024

Kshitij-Katiyar commented Jun 25, 2024

wiggin77 commented Aug 1, 2024

raghavaggarwal2308 commented Aug 6, 2024

wiggin77 commented Aug 6, 2024

wiggin77 left a comment

mattermost-build commented Sep 22, 2024

mattermost-build commented Oct 8, 2024

arush-vashishtha left a comment

[MM-356] Add feature to subscribe to release and workflow events #765

[MM-356] Add feature to subscribe to release and workflow events #765

Conversation

ayusht2810 commented Apr 8, 2024 • edited by fmartingr Loading

Summary

Screenshot

Ticket Link

What to test?

Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ayusht2810 May 1, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mickmister left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Kshitij-Katiyar commented Jun 25, 2024

wiggin77 commented Aug 1, 2024

raghavaggarwal2308 commented Aug 6, 2024

wiggin77 commented Aug 6, 2024

wiggin77 left a comment

Choose a reason for hiding this comment

mattermost-build commented Sep 22, 2024

mattermost-build commented Oct 8, 2024

arush-vashishtha left a comment

Choose a reason for hiding this comment

ayusht2810 commented Apr 8, 2024 •

edited by fmartingr

Loading

ayusht2810 May 1, 2024 •

edited

Loading