You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/semgrep-appsec-platform/jira.md
+17-20Lines changed: 17 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,10 +16,6 @@ import PL from '@site/src/components/Placeholder';
16
16
17
17
The Semgrep Jira integration allows you to create Jira tickets based on your Semgrep Code, Supply Chain, and Secrets findings.
18
18
19
-
:::info
20
-
The Jira integration is currently in beta.
21
-
:::
22
-
23
19
## Prerequisites
24
20
25
21
- You must have a **Jira Cloud** plan. Jira Data Center (self-managed or on-premise) is not supported.
@@ -31,10 +27,7 @@ The Semgrep Jira integration provides the following capabilities:
31
27
32
28
- You can create tickets for findings from Semgrep Code, Supply Chain, and Secrets.
33
29
- 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.
34
-
- You can automate the creation of tickets for critical or high severity, high confidence findings in your [primary branch](/deployment/primary-branch).
35
-
- Automated ticket creation can be configured on a per-product setting.
36
-
- For Supply Chain findings, tickets are created for reachable findings.
37
-
- Tickets are automatically created for **new** findings generated by scans that occur **after** enabling automated ticket creation. Tickets are not automatically created for existing findings.
30
+
- 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.
38
31
- Tickets can be created in **multiple Jira projects** if manually specified at ticket creation time.
39
32
40
33
@@ -50,7 +43,7 @@ To enable the Jira integration, follow these steps:
50
43
51
44
1. Sign in to [Semgrep AppSec Platform](https://semgrep.dev/login).
52
45
2. Navigate to [**Settings** > **Integrations**](https://semgrep.dev/orgs/-/settings/integrations).
53
-
3.If this is your first integration, click **Set up First Integration**. Otherwise, click **Add**. In the drop-down menu that appears, select **Jira**.
46
+
3.Click **Add**. In the menu that appears, select **Jira**.
54
47
4. Follow the on-screen instructions to grant Semgrep the necessary permissions and set up the integration.
55
48
5. When prompted, select the Jira instance you want to connect to. If you have multiple Jira instances, choose one instance from the **Use app on** drop-down menu.
56
49
***For deployments that have used a previous version of the Jira integration**: Ensure you're connecting to the same Jira instance you previously connected to. Please contact Semgrep if you want to connect to a different Jira instance.
@@ -69,11 +62,15 @@ Once you have enabled the Jira integration, you must complete the following step
- For Code, Semgrep automatically creates tickets for **critical or high severity, high confidence findings** on the **primary** branch.
74
-
- For Supply Chain, Semgrep automatically creates tickets for **critical or high severity reachable findings** on the **primary** branch.
75
-
- For Secrets, Semgrep automatically creates tickets for **critical or high severity validated secrets** on **any** branch.
76
-
:::
65
+
### Automatic creation of tickets
66
+
67
+
All products limit automatic ticket creation to **Critical** or **High** severity findings. Code findings must also be on your [primary branch](/deployment/primary-branch).
68
+
69
+
- For Code, Semgrep automatically creates tickets for **high confidence findings**.
70
+
- For Supply Chain, Semgrep automatically creates tickets for **reachable findings** on the primary branch and **malicious dependency findings** on **any** branch.
71
+
- For Secrets, Semgrep automatically creates tickets for **validated secrets** on **any** branch.
72
+
73
+
Tickets are automatically created for new findings after each scan completes. These tickets always group findings by rule when a scan identifies multiple new findings for the same rule.
77
74
78
75
### Automatic detection of other Jira projects
79
76
@@ -164,7 +161,7 @@ You can map multiple labels to a single Semgrep field when creating a field mapp
164
161
165
162
1. Select **Labels** under **Jira fields**.
166
163
1. Select **Set a static value** under **Semgrep fields**. A text box appears.
167
-
1. Enter each label, separated by a comma. Each of these labels are then added to the ticket.
164
+
1. Enter each label, separated by a comma. Each of these labels is then added to the ticket.
168
165
169
166
:::tip
170
167
The **Project tag** Semgrep field also creates multiple labels.
@@ -211,7 +208,7 @@ To create tickets:
211
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.
212
209
1. Select the **Create tickets...** checkbox.
213
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**.
214
-
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.
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.
215
212
1. Optional: You can add **Comments** in the text box.
Once a ticket has been created, a link appears on the **Findings** page and along the top of an individual finding's details page.
224
+
Once a ticket has been created, a link appears on the **Findings** page and in the sidebar of an individual finding's details page.
228
225
229
226

230
227
_**Figure.** Ticket created and its ID shown on the finding listed on the Code page._
@@ -247,7 +244,7 @@ To create tickets:
247
244
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.
248
245
1. Select the **Create tickets...** checkbox.
249
246
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**.
250
-
1. Optional: Click the **JIRA project** drop-down list to select which Jira project to add the findings to.
247
+
1. Optional: Click the **Jira project** drop-down list to select which Jira project to add the findings to.
251
248
1. Optional: You can add **Comments** in the text box.
252
249
1. Click **Submit** to proceed.
253
250
<!-- vale on -->
@@ -269,7 +266,7 @@ To create tickets:
269
266
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.
270
267
1. Select the **Create tickets...** checkbox.
271
268
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**.
272
-
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.
269
+
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.
273
270
1. Optional: You can add **Comments** in the text box.
Semgrep provides an API endpoint you can use to create Jira tickets, either by passing a list of `issue_ids` or filter query parameters to select findings. Refer to the [<iclass="fas fa-external-link fa-xs"></i> Jira API documentation](https://semgrep.dev/api/v1/docs/#tag/TicketingService/operation/semgrep_app.core_exp.notifications.ticketing.handlers.openapi_create_tickets).
283
+
Semgrep provides an API endpoint you can use to create Jira tickets, either by passing a list of `issue_ids` or filter query parameters to select findings. Refer to the [<iclass="fas fa-external-link fa-xs"></i> Jira endpoint documentation](https://semgrep.dev/api/v1/docs/#tag/TicketingService/operation/TicketingService_CreateTicket).
0 commit comments