Skip to content

chore: [FAN-121] add broker configuration details for breakability #1064

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

Open
neil-snyk wants to merge 1 commit into
base: main
Choose a base branch
from
Open

chore: [FAN-121] add broker configuration details for breakability #1064

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 18 additions & 0 deletions ...with-snyk/pull-requests/snyk-pull-or-merge-requests/breakability-risk-levels.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,3 +91,21 @@ The following use cases show how the logic applies.
| 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. |
| 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. |
| | | | |
## Using breakability with Snyk Broker

{% hint style="warning" %}
Breakability comments require your broker configuration to include the rule for creating pull request comments.

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.

If you maintain a custom `accept.json` configuration, verify it includes the appropriate rule for your SCM:

- **GitHub/GHE:** `POST /repos/:name/:repo/issues/:issueNumber/comments`
- **GitLab:** `POST /api/v4/projects/:project/merge_requests/:pullRef/notes`
- **Azure Repos:** `POST /:owner/_apis/git/repositories/:repo/pullRequests/:pullRef/threads`
- **Bitbucket Server:** `POST /rest/api/1.0/projects/:project/repos/:repo/pull-requests/:pullRequestId/comments`

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.

See [Snyk Broker documentation](https://docs.snyk.io/enterprise-setup/snyk-broker) for configuration details.
{% endhint}
Loading