Skip to content

Commit f224fbc

Browse files
committed
chore: [FAN-121] add broker configuration details for breakability
1 parent af0a616 commit f224fbc

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

docs/scan-with-snyk/pull-requests/snyk-pull-or-merge-requests/breakability-risk-levels.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,3 +91,21 @@ The following use cases show how the logic applies.
9191
| API removal | From `3.0` to `4.0` | High | The changelog confirms that `_.pluck` was removed and must be replaced with `_.map`. Code changes are required. |
9292
| Long term support drop | From `5.0` to `6.0` | High | The upgrade drops support for Java 17, which is an active LTS. This upgrade breaks builds that are running on standard environments. |
9393
| | | | |
94+
## Using breakability with Snyk Broker
95+
96+
{% hint style="warning" %}
97+
Breakability comments require your broker configuration to include the rule for creating pull request comments.
98+
99+
If you use the official broker templates ([available here](https://github.com/snyk/broker/tree/master/client-templates)), this rule is already included. Ensure your `accept.json` is up-to-date with the latest template for your SCM platform.
100+
101+
If you maintain a custom `accept.json` configuration, verify it includes the appropriate rule for your SCM:
102+
103+
- **GitHub/GHE:** `POST /repos/:name/:repo/issues/:issueNumber/comments`
104+
- **GitLab:** `POST /api/v4/projects/:project/merge_requests/:pullRef/notes`
105+
- **Azure Repos:** `POST /:owner/_apis/git/repositories/:repo/pullRequests/:pullRef/threads`
106+
- **Bitbucket Server:** `POST /rest/api/1.0/projects/:project/repos/:repo/pull-requests/:pullRequestId/comments`
107+
108+
If the rule is missing, the PR and PR summary will be generated successfully, but the comment containing the breakability risk level and analysis will fail to post to your pull request.
109+
110+
See [Snyk Broker documentation](https://docs.snyk.io/enterprise-setup/snyk-broker) for configuration details.
111+
{% endhint}

0 commit comments

Comments
 (0)