Skip to content

Commit a329b30

Browse files
khorne3abhijna
andauthored
update Jira doc (#2578)
* update Jira doc * Update docs/semgrep-appsec-platform/jira.md Co-authored-by: Abhijna Parigi <abhijna@semgrep.com> * Update docs/semgrep-appsec-platform/jira.md Co-authored-by: Abhijna Parigi <abhijna@semgrep.com> --------- Co-authored-by: Abhijna Parigi <abhijna@semgrep.com>
1 parent 06f56f6 commit a329b30

1 file changed

Lines changed: 112 additions & 39 deletions

File tree

  • docs/semgrep-appsec-platform

docs/semgrep-appsec-platform/jira.md

Lines changed: 112 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ tags:
1111
---
1212

1313
import PL from '@site/src/components/Placeholder';
14+
import Tabs from '@theme/Tabs';
15+
import TabItem from '@theme/TabItem';
1416

1517
# Create Jira tickets
1618

@@ -26,7 +28,7 @@ The Semgrep Jira integration allows you to create Jira tickets based on your Sem
2628

2729
The Semgrep Jira integration provides the following capabilities:
2830

29-
- You can create tickets for findings from Semgrep Code, Supply Chain, and Secrets.
31+
- You can create tickets for findings from Semgrep Code, including those from AI-powered detection, Supply Chain, and Secrets.
3032
- You can create a single ticket for multiple findings (up to 75) that were detected by a single rule in the same project, or create individual tickets per finding.
3133
- You can automate the creation of tickets for critical or high severity findings. See [Automatic creation of tickets](#automatic-creation-of-tickets) for more details.
3234
- Tickets can be created in **multiple Jira projects** if manually specified at ticket creation time.
@@ -64,7 +66,7 @@ Once you have enabled the Jira integration, you must complete the following step
6466

6567
All products limit automatic ticket creation to **Critical** or **High** severity findings. Code findings must also be on your [primary branch](/deployment/primary-branch).
6668

67-
- For Code, Semgrep automatically creates tickets for **high confidence findings**.
69+
- For Code, Semgrep automatically creates tickets for **high confidence findings**. All criteria for Code also apply to AI-powered detection findings.
6870
- For Supply Chain, Semgrep automatically creates tickets for **reachable findings** on the primary branch and **malicious dependency findings** on **any** branch.
6971
- For Secrets, Semgrep automatically creates tickets for **validated secrets** on **any** branch.
7072

@@ -101,7 +103,7 @@ The integration supports the use of custom Jira issue types and custom fields. H
101103

102104
To create a field mapping:
103105

104-
1. Select the Semgrep product for which the mapping is valid: **Code**, **Supply Chain**, or **Secrets**.
106+
1. Select the Semgrep product for which the mapping is valid: **Code**, **Supply Chain**, **Secrets**, or **Code (AI)**.
105107
2. Click **Add mapping**.
106108
3. Select the **Jira field** to which the Semgrep data should be mapped. You can [create a new field](https://support.atlassian.com/jira-cloud-administration/docs/create-a-custom-field/) if necessary. If you opt not to add Semgrep values to your Jira fields, you can create an [automation to map to your field values](https://www.atlassian.com/software/jira/guides/automation/overview#what-is-automation).
107109
4. Select the **Semgrep field** that holds the data to be mapped.
@@ -181,10 +183,6 @@ If you opt for a drop-down or a checkbox issue type field, verify that:
181183
* There are no misspellings.
182184
* No valid options are missing. If your drop-down or checkbox issue type is missing the `Medium` option, Jira cannot create tickets for medium-severity findings.
183185

184-
## Create tickets
185-
186-
After setting up your Jira integration, you're now ready to create Jira tickets. Jira tickets can be created from findings in Semgrep Code, Supply Chain, and Secrets. Jira tickets cannot be created for [findings with a status of **Fixed**](/semgrep-code/triage-remediation#triage-statuses) or [removed findings](/semgrep-code/triage-remediation#removed-findings), since those findings no longer require action to address.
187-
188186
### Component Mappings
189187

190188
If you've created a custom field mapping for a component field type, be aware that if you choose to create tickets in a Jira project other than your default Jira project as configured in your integration settings, you must ensure that project has a component available with the same name as the component you selected for your mapping.
@@ -193,24 +191,46 @@ If your default project uses [**Jira components**](https://support.atlassian.com
193191

194192
If your default project uses [**Compass components**](https://support.atlassian.com/jira-software-cloud/docs/what-are-compass-components/) and you create a component field mapping in your integration settings, you can create tickets in another project **only if your selected Compass component is available in that project**. You can configure which components are available in each project in your Compass settings.
195193

196-
### Code
194+
## Create tickets
195+
196+
After setting up your Jira integration, you're now ready to create Jira tickets. Jira tickets can be created from findings in Semgrep Code, including findings from AI-powered scans, Supply Chain, and Secrets. Jira tickets cannot be created for [findings with a status of **Fixed**](/semgrep-code/triage-remediation#triage-statuses) or [removed findings](/semgrep-code/triage-remediation#removed-findings), since those findings no longer require action to address.
197+
198+
<Tabs
199+
defaultValue="code"
200+
values={[
201+
{label: 'Code', value: 'code'},
202+
{label: 'Supply Chain', value: 'supply-chain'},
203+
{label: 'Secrets', value: 'secrets'},
204+
{label: 'Code (AI)', value: 'code-ai'},
205+
]}
206+
>
207+
208+
<TabItem value='code'>
197209

198210
You can create tickets for Code findings using the **Triage** button on the:
199211

200212
* [**Findings**](https://semgrep.dev/orgs/-/findings) page
201213
* Individual finding's **Details** page
202214

203-
To create tickets:
215+
To create tickets from the [**Findings**](https://semgrep.dev/orgs/-/findings) page
204216

205217
<!-- vale off-->
206-
1. If you're on the [**Findings**](https://semgrep.dev/orgs/-/findings) page, select the findings for which you want tickets created; you can select and create tickets for individual findings or all findings for a given rule. Otherwise, proceed to step 2.
207-
1. Click **Triage**.
208-
1. Set the status to **Open**, **Fixing**, or **Reviewing**. Select **Fixing** if it is a known issue that needs to be fixed or **Reviewing** if the finding needs more investigation.
209-
1. Select the **Create tickets...** checkbox.
210-
1. Optional: Click the first drop-down list to choose between making a ticket for **groups of findings** or an individual ticket for **each finding**.
211-
1. Optional: Click the **Jira project** drop-down list to select which Jira project to add the findings to. You can choose any project that is associated with the issue type configured in your integration settings.
212-
1. Optional: You can add **Comments** in the text box.
213-
1. Click **Submit** to proceed.
218+
1. Select the findings for which you want tickets created. You can select and create tickets for individual findings or all findings for a given rule.
219+
2. Click **Triage**.
220+
3. Set the status to **Open**, **Fixing**, or **Reviewing**. Select **Fixing** if it is a known issue that needs to be fixed or **Reviewing** if the finding needs more investigation.
221+
5. Optional: You can add **Comments** in the text box.
222+
4. Select the **Create tickets...** checkbox.
223+
1. Optional: If you've selected multiple findings, click the first drop-down list to choose between making a ticket for **groups of findings** or an individual ticket for **each finding**.
224+
2. Optional: Click the **Jira project** drop-down list to select which Jira project to add the findings to. You can choose any project that is associated with the issue type configured in your integration settings.
225+
5. Click **Submit** to proceed.
226+
227+
To create a ticket from the individual finding's **Details** page:
228+
229+
1. Go to the [**Findings**](https://semgrep.dev/orgs/-/findings) page, and identify the finding for which you'd like to create a ticket.
230+
2. Click the finding to open it's **Details** page.
231+
3. Click **Fix** to open the drop-down menu, then select **Create ticket...**.
232+
4. Select the **Jira project** that the ticket should be assigned to, and optionally, choose whether the status of the finding should be marked as **To fix** once Semgrep creates the ticket.
233+
5. Click **Create** to proceed.
214234
<!-- vale on -->
215235

216236
:::info
@@ -220,40 +240,93 @@ To create tickets:
220240

221241
Once a ticket has been created, a link appears on the **Findings** page and in the sidebar of an individual finding's details page.
222242

223-
### Supply Chain
243+
</TabItem>
224244

245+
<TabItem value='supply-chain'>
225246
You can create tickets for Supply Chain findings using the **Triage** button on the:
226247

227-
* [**Supply Chain > Vulnerabilities**](https://semgrep.dev/orgs/-/supply-chain/vulnerabilities) page
248+
* [**Supply Chain**](https://semgrep.dev/orgs/-/supply-chain) page
228249
* Individual finding's **Details** page
229250

230-
To create tickets:
251+
To create tickets from the [**Supply Chain**](https://semgrep.dev/orgs/-/supply-chain) page
231252

232253
<!-- vale off-->
233-
1. If you're on the [**Supply Chain > Vulnerabilities**](https://semgrep.dev/orgs/-/supply-chain/vulnerabilities) page, select the findings for which you want tickets created. Otherwise, proceed to step 2.
234-
1. Click **Triage**.
235-
1. Set the status to **Open**, **Fixing**, or **Reviewing**. Select **Fixing** if it is a known issue that needs to be fixed or **Reviewing** if the finding needs more investigation.
236-
1. Select the **Create tickets...** checkbox.
237-
1. Optional: Click the first drop-down list to choose between making a ticket for **groups of findings** or an individual ticket for **each finding**.
238-
1. Optional: Click the **Jira project** drop-down list to select which Jira project to add the findings to.
239-
1. Optional: You can add **Comments** in the text box.
240-
1. Click **Submit** to proceed.
254+
1. Select the findings for which you want tickets created. You can select and create tickets for individual findings or all findings for a given rule.
255+
2. Click **Triage**.
256+
3. Set the status to **Open**, **Fixing**, or **Reviewing**. Select **Fixing** if it is a known issue that needs to be fixed or **Reviewing** if the finding needs more investigation.
257+
4. Optional: You can add **Comments** in the text box.
258+
5. Select the **Create tickets...** checkbox.
259+
1. Optional: If you've selected multiple findings, click the first drop-down list to choose between making a ticket for **groups of findings** or an individual ticket for **each finding**.
260+
2. Optional: Click the **Jira project** drop-down list to select which Jira project to add the findings to. You can choose any project that is associated with the issue type configured in your integration settings.
261+
6. Click **Submit** to proceed.
262+
263+
To create a ticket from the individual finding's **Details** page:
264+
265+
1. Go to [**Supply Chain**](https://semgrep.dev/orgs/-/supply-chain), and identify the finding for which you'd like to create a ticket.
266+
2. Click the finding to open it's **Details** page.
267+
3. Click **Fix** to open the drop-down menu, then select **Create ticket...**.
268+
4. Select the **Jira project** that the ticket should be assigned to, and optionally, choose whether the status of the finding should be marked as **To fix** once Semgrep creates the ticket.
269+
5. Click **Create** to proceed.
241270
<!-- vale on -->
271+
</TabItem>
242272

243-
### Secrets
244-
245-
To create tickets:
273+
<TabItem value='secrets'>
246274

247275
<!-- vale off -->
248276

249-
1. If you're on the [**Secrets**](https://semgrep.dev/orgs/-/secrets) page, select the findings for which you want tickets created; you can select and create tickets for individual findings or all findings for a given rule. Otherwise, proceed to step 2.
250-
1. Click **Triage**.
251-
1. Set the status to **Open**, **Fixing**, or **Reviewing**. Select **Fixing** if it is a known issue that needs to be fixed or **Reviewing** if the finding needs more investigation.
252-
1. Select the **Create tickets...** checkbox.
253-
1. Optional: Click the first drop-down list to choose between making a ticket for **groups of findings** or an individual ticket for **each finding**.
254-
1. Optional: Click the **Jira project** drop-down list to select which Jira project to add the findings to. You can choose any project that is associated with the issue type configured in your integration settings.
255-
1. Optional: You can add **Comments** in the text box.
256-
1. Click **Submit** to proceed.
277+
You can create tickets for Secrets findings using the **Triage** button on the:
278+
279+
* [**Secrets**](https://semgrep.dev/orgs/-/secrets) page
280+
* Individual finding's **Details** page
281+
282+
To create tickets from the [**Secrets**](https://semgrep.dev/orgs/-/secrets) page
283+
284+
<!-- vale off-->
285+
1. Select the findings for which you want tickets created. You can select and create tickets for individual findings or all findings for a given rule.
286+
2. Click **Triage**.
287+
3. Set the status to **Open**, **Fixing**, or **Reviewing**. Select **Fixing** if it is a known issue that needs to be fixed or **Reviewing** if the finding needs more investigation.
288+
4. Optional: You can add **Comments** in the text box.
289+
5. Select the **Create tickets...** checkbox.
290+
1. Optional: If you've selected multiple findings, click the first drop-down list to choose between making a ticket for **groups of findings** or an individual ticket for **each finding**.
291+
2. Optional: Click the **Jira project** drop-down list to select which Jira project to add the findings to. You can choose any project that is associated with the issue type configured in your integration settings.
292+
6. Click **Submit** to proceed.
293+
294+
To create a ticket from the individual finding's **Details** page:
295+
296+
1. Go to [**Secrets**](https://semgrep.dev/orgs/-/secrets), and identify the finding for which you'd like to create a ticket.
297+
2. Click the finding to open it's **Details** page.
298+
3. Click **Fix** to open the drop-down menu, then select **Create ticket...**.
299+
4. Select the **Jira project** that the ticket should be assigned to, and optionally, choose whether the status of the finding should be marked as **To fix** once Semgrep creates the ticket.
300+
5. Click **Create** to proceed.
301+
</TabItem>
302+
303+
<TabItem value='code-ai'>
304+
You can create tickets for Code (AI) findings using the **Triage** button on the:
305+
306+
* [**Findings**](https://semgrep.dev/orgs/-/findings) page
307+
* Individual finding's **Details** page
308+
309+
To create tickets from the [**Findings**](https://semgrep.dev/orgs/-/findings) page
310+
311+
<!-- vale off-->
312+
1. If you're on the [**Findings**](https://semgrep.dev/orgs/-/findings) page, select the findings for which you want tickets created; you can select and create tickets for individual findings or all findings for a given rule.
313+
2. Click **Triage**.
314+
3. Set the status to **Open**, **Fixing**, or **Reviewing**. Select **Fixing** if it is a known issue that needs to be fixed or **Reviewing** if the finding needs more investigation.
315+
5. Optional: You can add **Comments** in the text box.
316+
4. Select the **Create tickets...** checkbox.
317+
1. Optional: If you've selected multiple findings, click the first drop-down list to choose between making a ticket for **groups of findings** or an individual ticket for **each finding**.
318+
2. Optional: Click the **Jira project** drop-down list to select which Jira project to add the findings to. You can choose any project that is associated with the issue type configured in your integration settings.
319+
5. Click **Submit** to proceed.
320+
321+
To create a ticket from the individual finding's **Details** page:
322+
323+
1. Go to the [**Findings**](https://semgrep.dev/orgs/-/findings) page, and identify the finding for which you'd like to create a ticket.
324+
2. Click the finding to open it's **Details** page.
325+
3. Click **Fix** to open the drop-down menu, then select **Create ticket...**.
326+
4. Select the **Jira project** that the ticket should be assigned to, and optionally, choose whether the status of the finding should be marked as **To fix** once Semgrep creates the ticket.
327+
5. Click **Create** to proceed.
328+
</TabItem>
329+
</Tabs>
257330

258331
<!-- vale on -->
259332

0 commit comments

Comments
 (0)