Skip to content

Commit e85e175

Browse files
committed
Merge branch 'main' into katiehorne/tec-430-update-docs-for-bngd-features
2 parents 6916fb1 + 71a3f1f commit e85e175

File tree

1 file changed

+17
-20
lines changed
  • docs/semgrep-appsec-platform

1 file changed

+17
-20
lines changed

docs/semgrep-appsec-platform/jira.md

Lines changed: 17 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,6 @@ import PL from '@site/src/components/Placeholder';
1616

1717
The Semgrep Jira integration allows you to create Jira tickets based on your Semgrep Code, Supply Chain, and Secrets findings.
1818

19-
:::info
20-
The Jira integration is currently in beta.
21-
:::
22-
2319
## Prerequisites
2420

2521
- 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:
3127

3228
- You can create tickets for findings from Semgrep Code, Supply Chain, and Secrets.
3329
- 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.
3831
- Tickets can be created in **multiple Jira projects** if manually specified at ticket creation time.
3932

4033

@@ -50,7 +43,7 @@ To enable the Jira integration, follow these steps:
5043

5144
1. Sign in to [Semgrep AppSec Platform](https://semgrep.dev/login).
5245
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**.
5447
4. Follow the on-screen instructions to grant Semgrep the necessary permissions and set up the integration.
5548
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.
5649
* **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
6962
![Jira configuration screen](/img/jira-subdomain.png#md-width)
7063
_**Figure.** The Jira configuration screen._
7164

72-
:::tip Automatic creation of tickets
73-
- 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.
7774

7875
### Automatic detection of other Jira projects
7976

@@ -164,7 +161,7 @@ You can map multiple labels to a single Semgrep field when creating a field mapp
164161

165162
1. Select **Labels** under **Jira fields**.
166163
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.
168165

169166
:::tip
170167
The **Project tag** Semgrep field also creates multiple labels.
@@ -211,7 +208,7 @@ To create tickets:
211208
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.
212209
1. Select the **Create tickets...** checkbox.
213210
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.
215212
1. Optional: You can add **Comments** in the text box.
216213
1. Click **Submit** to proceed.
217214
<!-- vale on -->
@@ -224,7 +221,7 @@ To create tickets:
224221
![Create Jira ticket - Code](/img/jira-code-findings.png#md-width)
225222
_**Figure.** Code triage flow._
226223

227-
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.
228225

229226
![Jira ticket created - Code](/img/jira-code-ticketed.png#md-width)
230227
_**Figure.** Ticket created and its ID shown on the finding listed on the Code page._
@@ -247,7 +244,7 @@ To create tickets:
247244
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.
248245
1. Select the **Create tickets...** checkbox.
249246
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.
251248
1. Optional: You can add **Comments** in the text box.
252249
1. Click **Submit** to proceed.
253250
<!-- vale on -->
@@ -269,7 +266,7 @@ To create tickets:
269266
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.
270267
1. Select the **Create tickets...** checkbox.
271268
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.
273270
1. Optional: You can add **Comments** in the text box.
274271
1. Click **Submit** to proceed.
275272

@@ -283,7 +280,7 @@ _**Figure.** Secrets ticket created._
283280

284281
## Create tickets through the Semgrep API
285282

286-
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 [<i class="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 [<i class="fas fa-external-link fa-xs"></i> Jira endpoint documentation](https://semgrep.dev/api/v1/docs/#tag/TicketingService/operation/TicketingService_CreateTicket).
287284

288285
## Ticket creation information
289286

0 commit comments

Comments
 (0)