Pull Request Experience
Last updated
Last updated
More information
Snyk privacy policy© 2024 Snyk Limited | All product and company names and logos are trademarks of their respective owners.
Feature availability
Pull Request Experience supports the following SCM integrations: GitHub, GitHub Enterprise, GitHub Cloud App, GitHub Server App, Bitbucket Cloud, and Bitbucket Cloud App.
The Snyk Pull Request Experience reduces context switching by displaying additional information about the PR Check scan results in the pull request.
Snyk PR Checks must be enabled. For more information, see Configure Pull Request Checks.
For the GitHub integration, a specific GitHub account needs to be set to open fix and upgrade PRs. The Personal Access Token (PAT) configured in this way is required by the Pull Request Experience to provide a consistent comment experience. For more information, see Opening fix and upgrade pull requests from a fixed GitHub account.
Release status
Issue Summary Comment for Snyk PR Checks is in Early Access.
The Issue Summary Comment feature adds a comment to each pull request, summarizing the latest PR Check results. The summary includes the type of checks performed and a breakdown of the findings by severity. Select View Details to access the PR Check details in the Snyk Web UI.
You can configure the Pull Request Experience at the Integration level for your Snyk Organization.
This feature works only for integrations where the Pull Request Experience is configured. If you have multiple integrations you must configure the Pull Request Experience for each one.
Configure the Pull Request Experience for one or more integrations in your Snyk Organization, for which PR Checks are also enabled.
In the Snyk Organization you wish to activate and configure the Pull Request Experience for, navigate to Settings > Integrations and select your connected source code manager to open the settings configuration.
Configure and save the following changes:
Enable issue summary comment: Enable this option to create an Issue Summary Comment on each pull request, which aggregates the PR Check results. If it is disabled, the entire Pull Request Experience is disabled.
Create comments for success cases: By default, an Issue Summary Comment is created even if no vulnerabilities are detected by the PR Check. Disable this option to stop creating Issue Summary Comments for non-failing PR Checks.
For the GitHub integration, configure opening fix and upgrade pull requests from a fixed GitHub account, by providing a Personal Access Token (PAT), which has write permissions or above to the repos monitored by Snyk. For more information, see Opening fix and upgrade pull requests from a fixed GitHub account.