Skip to content

Commit 94ba39f

Browse files
align optional features with support
1 parent ad810f0 commit 94ba39f

File tree

4 files changed

+13
-59
lines changed

4 files changed

+13
-59
lines changed

docs/semgrep-appsec-platform/azure-pr-comments.md

Lines changed: 3 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -136,34 +136,18 @@ steps:
136136
137137
<CommentsInSupplyChain />
138138
139-
## Customize PR comments
139+
## Optional features
140140
141-
<CustomComments comment_type="PR" link_type="HTML, Markdown, and plaintext" />
141+
### Customize PR comments
142142
143-
## Optional features
143+
<CustomComments comment_type="PR" link_type="HTML, Markdown, and plaintext" />
144144
145145
### Enable Autofix in Azure repositories
146146
147147
[Autofix](/writing-rules/autofix) is a Semgrep feature in which rules contain suggested fixes to resolve findings.
148148
149149
<EnableAutofix />
150150
151-
### Dataflow traces in MR comments
152-
153-
With **dataflow traces**, Semgrep Code provides you a visualization of the path of tainted, or untrusted, data in specific findings. This path can help you track the sources and sinks of the tainted data as they propagate through the body of a function or a method. For general information about taint analysis, see [Taint tracking](/writing-rules/data-flow/taint-mode/overview).
154-
155-
When running Semgrep Code from the command line, you can pass in the flag `--dataflow-traces` to use this feature.
156-
157-
You can view dataflow traces in the PR comments created by Semgrep Code.
158-
159-
#### View the path of tainted data in MR comments
160-
161-
To enable dataflow traces in your MR comments, fulfill the following prerequisites:
162-
163-
- Set up Semgrep to post Azure DevOps pull request comments, as described on this page.
164-
- To get the most meaningful results of dataflow traces in PR comments, use cross-file analysis while scanning your repositories. To enable cross-file analysis, see [<i class="fa-regular fa-file-lines"></i> Perform cross-file analysis](/semgrep-code/semgrep-pro-engine-intro).
165-
- Not all Semgrep rules or rulesets make use of taint tracking. Ensure that you have a ruleset such as the **default ruleset** added to your **[Policies](https://semgrep.dev/orgs/-/policies)**. If this ruleset is not added, go to [https://semgrep.dev/p/default](https://semgrep.dev/p/default), and then click **Add to Policy**. You can add rules that use taint tracking from [Semgrep Registry](https://semgrep.dev/explore).
166-
167151
## Next steps
168152
169153
<NextAfterComments />

docs/semgrep-appsec-platform/bitbucket-cloud-pr-comments.md

Lines changed: 3 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -225,34 +225,18 @@ Bitbucket Premium provides [<i class="fas fa-external-link fa-xs"></i> access co
225225
Only rules set to the **Comment** and **Block** rule modes in the [Policies page](https://semgrep.dev/orgs/-/policies) create PR comments.
226226
:::
227227
228-
## Customize PR comments
228+
## Optional features
229229
230-
<CustomComments comment_type="PR" link_type="Markdown and plaintext" />
230+
### Customize PR comments
231231
232-
## Optional features
232+
<CustomComments comment_type="PR" link_type="Markdown and plaintext" />
233233
234234
### Enable Autofix in Bitbucket Cloud repositories
235235
236236
[Autofix](/writing-rules/autofix) is a Semgrep feature in which rules contain suggested fixes to resolve findings.
237237
238238
<EnableAutofix />
239239
240-
### Dataflow traces in MR comments
241-
242-
With **dataflow traces**, Semgrep Code provides you a visualization of the path of tainted, or untrusted, data in specific findings. This path can help you track the sources and sinks of the tainted data as they propagate through the body of a function or a method. For general information about taint analysis, see [Taint tracking](/writing-rules/data-flow/taint-mode/overview).
243-
244-
When running Semgrep Code from the command line, you can pass in the flag `--dataflow-traces` to use this feature.
245-
246-
You can view dataflow traces in the PR comments created by Semgrep Code.
247-
248-
#### View the path of tainted data in PR comments
249-
250-
To enable dataflow traces in your PR comments, fulfill the following prerequisites:
251-
252-
- Set up Semgrep to post Bitbucket Cloud pull request comments, as described on this page.
253-
- To get the most meaningful results of dataflow traces in PR comments, use cross-file analysis while scanning your repositories. To enable cross-file analysis, see [<i class="fa-regular fa-file-lines"></i> Perform cross-file analysis](/semgrep-code/semgrep-pro-engine-intro).
254-
- Not all Semgrep rules or rulesets make use of taint tracking. Ensure that you have a ruleset such as the **default ruleset** added to your **[Policies](https://semgrep.dev/orgs/-/policies)**. If this ruleset is not added, go to [https://semgrep.dev/p/default](https://semgrep.dev/p/default), and then click **Add to Policy**. You can add rules that use taint tracking from [Semgrep Registry](https://semgrep.dev/explore).
255-
256240
## Next steps
257241
258242
<NextAfterComments />

docs/semgrep-appsec-platform/bitbucket-data-center-pr-comments.md

Lines changed: 3 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,9 @@ Once you've successfully enabled webhooks and the **Triage via code review comme
8686

8787
<CommentsInSupplyChain />
8888

89-
## Customize PR comments
89+
## Optional features
90+
91+
### Customize PR comments
9092

9193
<CustomComments comment_type="PR" link_type="Markdown and plaintext" />
9294

@@ -96,22 +98,6 @@ Once you've successfully enabled webhooks and the **Triage via code review comme
9698

9799
<EnableAutofix />
98100

99-
### Dataflow traces in MR comments
100-
101-
With **dataflow traces**, Semgrep Code provides you a visualization of the path of tainted, or untrusted, data in specific findings. This path can help you track the sources and sinks of the tainted data as they propagate through the body of a function or a method. For general information about taint analysis, see [Taint tracking](/writing-rules/data-flow/taint-mode/overview).
102-
103-
When running Semgrep Code from the command line, you can pass in the flag `--dataflow-traces` to use this feature.
104-
105-
You can view dataflow traces in the PR comments created by Semgrep Code.
106-
107-
#### View the path of tainted data in PR comments
108-
109-
To enable dataflow traces in your PR comments, fulfill the following prerequisites:
110-
111-
- Set up Semgrep to post Bitbucket Data Center pull request comments, as described on this page.
112-
- To get the most meaningful results of dataflow traces in PR comments, use cross-file analysis while scanning your repositories. To enable cross-file analysis, see [<i class="fa-regular fa-file-lines"></i> Perform cross-file analysis](/semgrep-code/semgrep-pro-engine-intro).
113-
- Not all Semgrep rules or rulesets make use of taint tracking. Ensure that you have a ruleset such as the **default ruleset** added to your **[Policies](https://semgrep.dev/orgs/-/policies)**. If this ruleset is not added, go to [https://semgrep.dev/p/default](https://semgrep.dev/p/default), and then click **Add to Policy**. You can add rules that use taint tracking from [Semgrep Registry](https://semgrep.dev/explore).
114-
115101
## Next steps
116102

117103
<NextAfterComments />

docs/semgrep-appsec-platform/gitlab-mr-comments.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,10 @@ You've set up MR comments! Enable optional features provided in the following se
9797

9898
## Optional features
9999

100+
### Customize MR comments
101+
102+
<CustomComments comment_type="MR" link_type="HTML, Markdown, and plaintext" />
103+
100104
### Enable Autofix in GitLab repositories
101105

102106
[Autofix](/writing-rules/autofix) is a Semgrep feature in which rules contain suggested fixes to resolve findings.
@@ -119,10 +123,6 @@ To enable dataflow traces in your MR comments, fulfill the following prerequisit
119123
- To get the most meaningful results of dataflow traces in MR comments, use cross-file analysis while scanning your repositories. To enable cross-file analysis, see [<i class="fa-regular fa-file-lines"></i> Perform cross-file analysis](/semgrep-code/semgrep-pro-engine-intro).
120124
- Not all Semgrep rules or rulesets make use of taint tracking. Ensure that you have a ruleset such as the **default ruleset** added to your **[Policies](https://semgrep.dev/orgs/-/policies)**. If this ruleset is not added, go to [https://semgrep.dev/p/default](https://semgrep.dev/p/default), and then click **Add to Policy**. You can add rules that use taint tracking from [Semgrep Registry](https://semgrep.dev/explore).
121125

122-
### Customize MR comments
123-
124-
<CustomComments comment_type="MR" link_type="HTML, Markdown, and plaintext" />
125-
126126
## Next steps
127127

128128
<NextAfterComments />

0 commit comments

Comments
 (0)