Skip to content

Commit 8dcd510

Browse files
toshiki-hayashi-snykgitbook-bot
authored andcommitted
GITBOOK-10375: NE - Clarify PR Check inline comment prerequisites
1 parent 46059cf commit 8dcd510

File tree

2 files changed

+6
-1
lines changed

2 files changed

+6
-1
lines changed
183 KB
Loading

docs/scan-with-snyk/pull-requests/pull-request-checks/pull-request-experience.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,10 +43,13 @@ Ensure the following is complete:
4343
Additional to the general SCM and PR Checks prerequisites, certain features within the pull request experience have their own requirements:
4444

4545
* To configure the inline comments feature, enable the **Code analysis** PR checks setting. This is located on the Organization level under **Settings** > **Integrations**.
46-
* Specify a dedicated GitHub account if you are using a GitHub integration. This helps Snyk identify the comments source on pull requests.
4746

4847
<figure><img src="../../../.gitbook/assets/Screenshot 2024-11-27 at 14.14.35.png" alt=""><figcaption><p>Code analysis feature for pull request status checks</p></figcaption></figure>
4948

49+
* If you are using the GitHub Integration, specify a dedicated GitHub account by supplying a **GitHub Personal Access Token (PAT)** in the integration settings. This is required to be able to add inline comments or Agent Fix
50+
51+
<figure><img src="../../../.gitbook/assets/github_pr_settings.png" alt=""><figcaption></figcaption></figure>
52+
5053
### SCM permission and access scope requirements
5154

5255
The pull request experience integrates with various SCM platforms, each with specific requirements for a successful configuration with Snyk. Your existing SCM integration setup will work with the Pull Request experience out of the box, except for GitHub (OAuth) which requires an additional Fix PR token. For additional information, see [User permissions and access scopes](../../../developer-tools/scm-integrations/user-permissions-and-access-scopes.md).
@@ -157,6 +160,8 @@ Inline comments are available only for issues detected by Snyk Code PR Checks. T
157160

158161
2. **Code Analysis** is enabled in the Pull request status checks section for your integration.
159162

163+
PR Comments can only be added for issues detected in a PR Check. If issues are of lower severity than your Fail Condition, the PR check will not detect them.
164+
160165
<figure><img src="../../../.gitbook/assets/enable_code_analysis.png" alt=""><figcaption><p>Configuration details to enable Code Analysis</p></figcaption></figure>
161166

162167
3. **Inline Comments** are enabled in the **Pull Request Experience** section for your integration.

0 commit comments

Comments
 (0)