Skip to content

Commit

Permalink
Add details about the failure notification feature (#7394)
Browse files Browse the repository at this point in the history
* Add details about the failure notification feature

* PR feedbacks
  • Loading branch information
MattGal authored May 20, 2021
1 parent 4d17317 commit 349d4a3
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions Documentation/BranchesChannelsAndSubscriptions.md
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 a public member of 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.

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

0 comments on commit 349d4a3

Please sign in to comment.