Skip to content

Commit b994e48

Browse files
authored
Merge pull request #13770 from DefectDojo/master-into-dev/2.52.3-2.53.0-dev
Release: Merge back 2.52.3 into dev from: master-into-dev/2.52.3-2.53.0-dev
2 parents e037f89 + c7b813f commit b994e48

File tree

18 files changed

+572
-52
lines changed

18 files changed

+572
-52
lines changed

.github/dependabot.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ updates:
1111
versions:
1212
- ">= 5.a"
1313
- "< 6"
14+
- dependency-name: boto3
15+
update-types: ["version-update:semver-minor"]
1416
- package-ecosystem: npm
1517
directory: "/components"
1618
schedule:

.github/renovate.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
"description": "Update renovate weekly (sundays) - They are releasing new versions too often, so it is a bit noisy, and keeping renovating a bit older does not create vulnerabilities in DD",
2727
"matchDatasources": "github-releases",
2828
"matchPackageNames": "renovatebot/renovate",
29+
"separateMinorPatch": false,
2930
"schedule": ["* * * * 0"]
3031
},{
3132
"description": "Minikube does not like freshly released k8s. We need to wait some time so it will be adopted",

.github/workflows/gh-pages.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,11 @@ name: github-pages
33
on:
44
workflow_dispatch:
55
push:
6+
paths:
7+
- 'docs/**'
68
branches:
79
- master
10+
- bugfix
811

912
# Taken from https://github.com/marketplace/actions/hugo-setup#%EF%B8%8F-workflow-for-autoprefixer-and-postcss-cli
1013
# Both builds have to be one worflow as otherwise one publish will overwrite the other

.github/workflows/test-helm-chart.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ jobs:
6666
if: env.changed == 'true'
6767

6868
- name: Check update of "artifacthub.io/changes" HELM annotation
69-
if: env.changed == 'true'
69+
if: ${{ env.changed == 'true' && !(startsWith(github.head_ref, 'master-into-dev/') || startsWith(github.head_ref, 'master-into-bugfix/')) }}
7070
run: |
7171
# fast fail if `git show` fails
7272
set -e

docs/content/en/share_your_findings/jira_guide.md

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ description: "Work with the Jira integration"
44
weight: 1
55
---
66

7-
DefectDojo's Jira integration can be used to push Finding data to one or more Jira Projects. By doing so, you can integrate DefectDojo into your standard development workflow. Here are some examples of how this can work:
7+
DefectDojo's Jira integration can be used to push Finding data to one or more Jira Spaces. By doing so, you can integrate DefectDojo into your standard development workflow. Here are some examples of how this can work:
88

9-
* The AppSec team can selectively push Findings to a Jira Project used by developers, so that issue remediation can be appropriately prioritized alongside regular development. Developers on this board don't need to access DefectDojo - they can keep all their work in one place.
10-
* DefectDojo can push ALL Findings to a bidirectional Jira Project which the AppSec team uses, which allows them to split up issue validation. This board keeps in sync with DefectDojo and allows for complex remediation workflows.
11-
* DefectDojo can selectively push Findings from separate Products &/or Engagements to separate Jira Projects, to keep things in their proper context.
9+
* The AppSec team can selectively push Findings to a Jira Space used by developers, so that issue remediation can be appropriately prioritized alongside regular development. Developers on this board don't need to access DefectDojo - they can keep all their work in one place.
10+
* DefectDojo can push ALL Findings to a bidirectional Jira Space which the AppSec team uses, which allows them to split up issue validation. This board keeps in sync with DefectDojo and allows for complex remediation workflows.
11+
* DefectDojo can selectively push Findings from separate Products &/or Engagements to separate Jira Spaces, to keep things in their proper context.
1212

1313
# Setting Up Jira
1414
Setting Up Jira requires the following steps:
@@ -40,7 +40,7 @@ Optionally, you can map:
4040
* Jira Transitions to trigger Re-Opening and Closing Findings
4141
* Jira Resolutions which can apply Risk Acceptance and False Positive statuses to Findings (optional)
4242

43-
Multiple Jira Projects can be handled by a single Jira Instance connection, as long as the Jira account / token used by DefectDojo has permission to create Issues in the associated Jira Project.
43+
Multiple Jira Spaces can be handled by a single Jira Instance connection, as long as the Jira account / token used by DefectDojo has permission to create Issues in the associated Jira Space.
4444

4545
### Add a Jira Instance (Pro UI)
4646

@@ -62,7 +62,7 @@ Multiple Jira Projects can be handled by a single Jira Instance connection, as l
6262
Note that the user associated with this connection have permission to create Issues and access data in your Jira instance.
6363

6464
6. You will need to provide values for an Epic Name ID, Re-open Transition ID and Close Transition ID. These values can be changed later. While logged into Jira, you can access these values from the following URLs:
65-
- **Epic Name ID**: visit `https://<YOUR JIRA URL>/rest/api/2/field` and search for Epic Name. Copy the number out of `number` and paste it here.
65+
- **Epic Name ID**: visit `https://<YOUR JIRA URL>/rest/api/2/field` and search for Epic Name. Copy the number out of `number` and paste it here. If you do not have an Epic Name ID associated with your Space in Jira (due to using a Team-Managed Space, for example), enter 0 on this field.
6666
- **Re-open Transition ID**: visit `https://<YOUR JIRA URL>/rest/api/latest/issue/<ANY VALID ISSUE KEY>/transitions?expand-transitions.fields` to find the ID for your Jira instance. Paste it in the Reopen Transition ID field.
6767
- **Close Transition ID**: Visit `https://<YOUR JIRA URL>/rest/api/latest/issue/<ANY VALID ISSUE KEY>/transitions?expand-transitions.fields` to find the ID for your Jira instance. Paste it in the Close Transition ID field.
6868

@@ -88,11 +88,11 @@ The form can be submitted from here. If you wish, you can further customize you
8888
8989
![image](images/Connect_DefectDojo_to_Jira.png)
9090

91-
3. You will see a list of all currently configured Jira Projects which are linked to DefectDojo. To add a new Project Configuration, click the wrench icon and choose either the **Add Jira Configuration (Express)** or **Add Jira Configuration** options.
91+
3. You will see a list of all currently configured Jira Spaces which are linked to DefectDojo. To add a new Project Configuration, click the wrench icon and choose either the **Add Jira Configuration (Express)** or **Add Jira Configuration** options.
9292

9393
#### Add Jira Configuration (Express)
9494

95-
The Express method allows for a quicker method of linking a Project. Use the Express method if you simply want to connect a Jira Project quickly, and you aren’t dealing with a complex Jira workflow.
95+
The Express method allows for a quicker method of linking a Space. Use the Express method if you simply want to connect a Jira Space quickly, and you aren’t dealing with a complex Jira workflow.
9696

9797
![image](images/Connect_DefectDojo_to_Jira_2.png)
9898

@@ -122,7 +122,7 @@ If you leave this field blank, it will default to **Jira\_full.**
122122
123123
9. Decide whether you wish to automatically sync Findings with Jira. If this is enabled, Jira Issues will automatically be kept in sync with the related Findings. If this is not enabled, you will need to manually push any changes made to a Finding after the Issue has been created in Jira.
124124
125-
10. Select your Issue key. In Jira, this is the string associated with an Issue (e.g. the word **‘EXAMPLE’** in an issue called **EXAMPLE\-123**). If you don’t know your issue key, create a new Issue in the Jira Project. In the screenshot below, we can see that the issue key on our Jira Project is **DEF**.
125+
10. Select your Issue key. In Jira, this is the string associated with an Issue (e.g. the word **‘EXAMPLE’** in an issue called **EXAMPLE\-123**). If you don’t know your issue key, create a new Issue in the Jira Space. In the screenshot below, we can see that the issue key on our Jira Space is **DEF**.
126126
127127
![image](images/Connect_DefectDojo_to_Jira_3.png)
128128
@@ -154,23 +154,23 @@ Comments (in Jira) and Notes (in DefectDojo) can be kept in sync. This setting c
154154

155155
## Step 2: Connect a Product or Engagement to Jira
156156

157-
Each Product or Engagement in DefectDojo has its own settings which govern how Findings are converted to JIRA Issues. From here, you can decide the associated JIRA Project and set the default behaviour for creating Issues, Epics, Labels and other JIRA metadata.
157+
Each Product or Engagement in DefectDojo has its own settings which govern how Findings are converted to JIRA Issues. From here, you can decide the associated Jira Space and set the default behaviour for creating Issues, Epics, Labels and other JIRA metadata.
158158

159159
### Add Jira to a Product or Engagement (Pro UI)
160160

161-
You can find this page by clicking the Gear menu on a Product or Engagement - ⚙️ and opening the Jira Project Settings page.
161+
You can find this page by clicking the Gear menu on a Product or Engagement - ⚙️ and opening the Jira Space Settings page.
162162

163163
![image](images/jira-project-settings.png)
164164

165165
#### Jira Instance
166166

167-
If you have multiple instances of Jira set up, for separate products or teams within your organization, you can indicate which Jira Project you want DefectDojo to create Issues in. Select a Project from the drop\-down menu.
167+
If you have multiple instances of Jira set up, for separate products or teams within your organization, you can indicate which Jira Space you want DefectDojo to create Issues in. Select a Space from the drop\-down menu.
168168

169-
If this menu doesn't list any Jira instances, confirm that those Projects are connected in your global Jira Configuration for DefectDojo \- yourcompany.defectdojo.com/jira.
169+
If this menu doesn't list any Jira instances, confirm that those Space are connected in your global Jira Configuration for DefectDojo \- yourcompany.defectdojo.com/jira.
170170

171171
#### Project key
172172

173-
This is the key of the Project that you want to use with DefectDojo. The Project Key for a given project can be found in the URL.
173+
This is the key of the Space that you want to use with DefectDojo. The Space Key for a given Space can be found in the URL. (This was previously referred to as a **Jira Project Key**, but as of Sepetember 2025, this is now referred to in Jira as the **Space Key**).
174174

175175
![image](images/Add_a_Connected_Jira_Project_to_a_Product_3.png)
176176

@@ -192,15 +192,15 @@ Here is an example of a **jira\_full** Issue:
192192

193193
#### Component
194194

195-
If you manage your Jira project using Components, you can assign the appropriate Component for DefectDojo here.
195+
If you manage your Jira Space using Components, you can assign the appropriate Component for DefectDojo here.
196196

197197
**Custom fields**
198198

199199
If you don’t need to use Custom Fields with DefectDojo issues, you can leave this field as ‘null’.
200200

201-
However, if your Jira Project Settings **require you** to use Custom Fields on new Issues, you will need to hard-code these mappings.
201+
However, if your Jira Space Settings **require you** to use Custom Fields on new Issues, you will need to hard-code these mappings.
202202

203-
Note that DefectDojo cannot send any Issue\-specific metadata as Custom Fields, only a default value. This section should only be set up if your JIRA Project **requires that these Custom Fields exist** in every Issue in your project.
203+
Note that DefectDojo cannot send any Issue\-specific metadata as Custom Fields, only a default value. This section should only be set up if your Jira Space **requires that these Custom Fields exist** in every Issue in your Space.
204204

205205
Follow **[this guide](#custom-fields-in-jira)** to get started working with Custom Fields.
206206

@@ -212,7 +212,7 @@ Select the relevant labels that you want the Issue to be created with in Jira, e
212212

213213
#### Default assignee
214214

215-
The name of the default assignee in Jira. If left blank, DefectDojo will follow the default behaviour in your Jira Project when creating Issues.
215+
The name of the default assignee in Jira. If left blank, DefectDojo will follow the default behaviour in your Jira Space when creating Issues.
216216

217217
### Add Jira to a Product or Engagement (Classic UI / Open-Source)
218218

@@ -228,13 +228,13 @@ Jira settings are located near the bottom of the Product Settings page.
228228

229229
#### Jira Instance
230230

231-
If you have multiple instances of Jira set up, for separate products or teams within your organization, you can indicate which Jira Project you want DefectDojo to create Issues in. Select a Project from the drop\-down menu.
231+
If you have multiple instances of Jira set up, for separate products or teams within your organization, you can indicate which Jira Space you want DefectDojo to create Issues in. Select a Project from the drop\-down menu.
232232

233233
If this menu doesn't list any Jira instances, confirm that those Projects are connected in your global Jira Configuration for DefectDojo \- yourcompany.defectdojo.com/jira.
234234

235235
#### Project key
236236

237-
This is the key of the Project that you want to use with DefectDojo. The Project Key for a given project can be found in the URL.
237+
This is the key of the Space that you want to use with DefectDojo. The Space Key for a given project can be found in the URL, or under "Space key" listed in Space Settings.
238238

239239
![image](images/Add_a_Connected_Jira_Project_to_a_Product_3.png)
240240

@@ -256,17 +256,17 @@ Here is an example of a **jira\_full** Issue:
256256

257257
#### Component
258258

259-
If you manage your Jira project using Components, you can assign the appropriate Component for DefectDojo here.
259+
If you manage your Jira Space using Components, you can assign the appropriate Component for DefectDojo here.
260260

261261
**Custom fields**
262262

263263
If you don’t need to use Custom Fields with DefectDojo issues, you can leave this field as ‘null’.
264264

265-
However, if your Jira Project Settings **require you** to use Custom Fields on new Issues, you will need to hard\-code these mappings.
265+
However, if your Jira Space Settings **require you** to use Custom Fields on new Issues, you will need to hard\-code these mappings.
266266

267267
**Jira Cloud now allows you to create a default Custom Field value directly in\-app. [See Atlassian's documentation on Custom Fields](https://support.atlassian.com/jira-cloud-administration/docs/configure-a-custom-field/) for more information on how to configure this.**
268268

269-
Note that DefectDojo cannot send any Issue\-specific metadata as Custom Fields, only a default value. This section should only be set up if your JIRA Project **requires that these Custom Fields exist** in every Issue in your project.
269+
Note that DefectDojo cannot send any Issue\-specific metadata as Custom Fields, only a default value. This section should only be set up if your Jira Space **requires that these Custom Fields exist** in every Issue in your Space.
270270

271271
Follow **[this guide](#custom-fields-in-jira)** to get started working with Custom Fields.
272272

@@ -278,11 +278,11 @@ Select the relevant labels that you want the Issue to be created with in Jira, e
278278

279279
#### Default assignee
280280

281-
The name of the default assignee in Jira. If left blank, DefectDojo will follow the default behaviour in your Jira Project when creating Issues.
281+
The name of the default assignee in Jira. If left blank, DefectDojo will follow the default behaviour in your Jira Space when creating Issues.
282282

283283
### Additional Form Options
284284

285-
#### Enable Connection With Jira Project
285+
#### Enable Connection With Jira Space
286286

287287
Jira integrations can be removed from your instance only if no related Issues have been created. If Issues have been created, there is no way to completely remove a Jira Instance from DefectDojo.
288288

@@ -373,7 +373,7 @@ Add whatever title severity and description you wish, and then click “Finished
373373

374374
If Jira Issues are not being created correctly, check your Notifications for error codes.
375375

376-
* Confirm that the Jira User associated with DefectDojo's Jira Configuration has permission to create and update issues on that particular Jira Project.
376+
* Confirm that the Jira User associated with DefectDojo's Jira Configuration has permission to create and update issues on that particular Jira Space.
377377

378378
#### Test 2: Jira Webhooks send to DefectDojo
379379

@@ -389,7 +389,7 @@ If this doesn’t work correctly, it could be due to a Firewall issue on your Ji
389389

390390
Jira integrations can be removed from your instance only if no related Issues have been created. If Issues have been created, there is no way to completely remove a Jira Instance from DefectDojo.
391391

392-
However, you can disable your Jira integration by disabling it at the Product level. From the **Edit Product** form (Classic UI) or from the **Jira Product Settings** (Pro UI) you can uncheck the "Enable Connection With Jira Project" option. This will not delete or change any existing Jira tickets created by DefectDojo, but will disable any further updates.
392+
However, you can disable your Jira integration by disabling it at the Product level. From the **Edit Product** form (Classic UI) or from the **Jira Product Settings** (Pro UI) you can uncheck the "Enable Connection With Jira Space" option. This will not delete or change any existing Jira tickets created by DefectDojo, but will disable any further updates.
393393

394394
# Pushing Findings To Jira
395395

docs/content/en/share_your_findings/troubleshooting_jira.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -53,23 +53,25 @@ For example:
5353
curl -H "Authorization: Bearer ATATT1234567890abcdefghijklmnopqrstuvwxyz" https://<COMPANY>.atlassian.net/rest/api/latest/issue/<JIRA_ISSUE_KEY>/transitions?expand=transitions.fields
5454
```
5555

56+
## I can't find an Epic Name ID for my Space
57+
Certain Spaces in Jira, such as Team-Managed Spaces, do not use Epics and therefore will not have an Epic Name ID. In this case, set Epic Name ID to 0 in DefectDojo.
5658

5759
## Findings that I 'Push To Jira' do not appear in Jira
5860
Using the 'Push To Jira' workflow triggers an asynchronous process, however an Issue should be created in Jira fairly quickly after 'Push To Jira' is triggered.
5961

6062
* Check your DefectDojo notifications to see if the process was successful. If the push failed, you will get an error response from Jira in your notifications.
6163

6264
Common reasons issues are not created:
63-
* The Default Issue Type you have selected is not usable with the Jira Project
64-
* Issues in the Project have required attributes that prevent them from being created via DefectDojo (see our guide to [Custom Fields](../jira_guide/#custom-fields-in-jira))
65+
* The Default Issue Type you have selected is not usable with the Jira Space
66+
* Issues in the Space have required attributes that prevent them from being created via DefectDojo (see our guide to [Custom Fields](../jira_guide/#custom-fields-in-jira))
6567

6668

6769
## Error: Product Misconfigured or no permissions in Jira?
6870

6971
This error message can appear when attempting to add a created Jira configuration to a Product. DefectDojo will attempt to validate a connection to Jira, and if that connection fails, it will raise this error message.
7072

71-
* Check to see if your Jira credentials are allowed to create issues in the given Jira Project you have selected.
72-
* The "Project Key" field needs to be a valid Jira Project. Jira issues can use many different Keys within a single Project; the easiest way to confirm your Project Key is to look at the URL for that particular Jira Project: generally this will look like `https://xyz.atlassian.net/jira/core/projects/JTV/board`. In this case `JTV` is the Project Key.
73+
* Check to see if your Jira credentials are allowed to create issues in the given Jira Space you have selected.
74+
* The "Project Key" field needs to be a valid Jira Space. Jira issues can use many different Keys within a single Space; the easiest way to confirm your Project Key is to look at the URL for that particular Jira Space: generally this will look like `https://xyz.atlassian.net/jira/core/projects/JTV/board`. In this case `JTV` is the Space Key.
7375

7476
## Changes made to Jira issues are not updating Findings in DefectDojo
7577

@@ -87,7 +89,7 @@ This error message can appear when attempting to add a created Jira configuratio
8789

8890
DefectDojo's Jira integration needs a customfield value for 'Epic Name'. However, your Project settings might not actually use 'Epic Name' as a field when creating Epics. Atlassian made a change in [August 2023](https://community.atlassian.com/t5/Jira-articles/Upcoming-changes-to-epic-fields-in-company-managed-projects/ba-p/1997562) which combined the 'Epic Name' and 'Epic Summary' fields.
8991

90-
Newer Jira Projects might not use this field when creating Epics by default, which results in this error message.
92+
Newer Jira Spaces might not use this field when creating Epics by default, which results in this error message.
9193

9294
To correct this issue, you can add the 'Epic Name' field to your Project's issue creation screen:
9395

0 commit comments

Comments
 (0)