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.

Sign up for GitHub

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

Add details about the failure notification feature #7394

Merged
merged 2 commits into from
May 20, 2021
Merged

Add details about the failure notification feature #7394

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
09f436b
Add details about the failure notification feature
MattGal May 13, 2021
8b14a00
PR feedbacks
MattGal May 13, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions Documentation/BranchesChannelsAndSubscriptions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ Subscriptions have the following characteristics:

- They have a desired quality metric for when the mapping should be applied (e.g. should tests have passed?)
- They have a trigger for when the mapping should be applied.
- They may optionally include a list of GitHub logins (users who must be publicly in the Microsoft organization) or team aliases (for notification to work, this team must exist in the target repository's organization). When included in a non-batched subscription, failed policies for the pull requests produced will tag these users. As such, these users should be teams or users who represent subject-matter experts for the source repository of the subscription.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

'users who must be publicly in the Microsoft organization' -> 'must be a public member of the Microsoft organization'


A subscription can be visualized with the following pseudocode

Expand Down Expand Up @@ -84,6 +85,9 @@ A subscription can be visualized with the following pseudocode
if (subscription.isDesiredQuality(repo)) {
mergeChanges()
}
else if (subscription.hasFailureNotificationTags and subscription.isNotBatched) {
tagTheseUsersOnDependencyFlowPullRequest()
}
}
```

Expand Down