Skip to content

Commit a1a7fa6

Browse files
authored
Update Jira documentation to suggest the use of "Blank" template #348 (#378)
Signed-off-by: tdruez <[email protected]>
1 parent b86abef commit a1a7fa6

File tree

3 files changed

+16
-17
lines changed

3 files changed

+16
-17
lines changed

docs/integrations-jira.rst

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,17 @@ Prerequisites
1111
-------------
1212

1313
- A **Jira Cloud project** that you want to integrate with DejaCode.
14+
15+
.. note::
16+
17+
**The Jira project must have an editable workflow**, it is recommended to choose
18+
**Jira** > **Blank project** template during project creation.
19+
1420
- A **Jira user account** with sufficient permissions
15-
(at least *Create Issues* and *Edit Issues*) in that project.
21+
(at least **Create Issues** and **Edit Issues**) in that project.
1622

17-
Create Custom "DejaCode Request" Work Type
18-
------------------------------------------
23+
Create "DejaCode Request" Work Type
24+
-----------------------------------
1925

2026
.. warning::
2127

@@ -28,26 +34,21 @@ To create the custom work type in Jira:
2834
3. Set the name to: ``DejaCode Request``
2935
4. Click **Create**
3036

31-
Create "Closed" Status
32-
----------------------
37+
Define Open/Closed Statuses
38+
---------------------------
3339

3440
.. warning::
3541

3642
This is required for the integration to function properly.
3743

38-
This status will be set on the Jira issue when the DejaCode Request is closed.
39-
40-
To create the **Closed** status in Jira:
44+
To edit the workflow statuses in Jira:
4145

4246
1. Navigate to **Project settings** → **Work types**
4347
2. Select the ``DejaCode Request`` work type
4448
3. Click **Edit workflow**
45-
4. Click **Add status**
46-
5. Click **Create new status** tab
47-
6. Enter the name: ``Closed``
48-
7. Choose a category: ``Done``
49-
8. Click **Add**
50-
9. Click **Update workflow**
49+
4. Rename the ``TO DO`` status to ``OPEN``, keep the ``To do`` status category
50+
5. Rename the ``DONE`` status to ``CLOSED``, keep the ``Done`` status category
51+
6. Click **Update workflow** > **Save**
5152

5253
Jira API Token
5354
--------------

workflow/integrations/jira.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,6 @@ class JiraIntegration(BaseIntegration):
2222
"""
2323

2424
issuetype = "DejaCode Request"
25-
open_status = None
26-
closed_status = "Closed"
2725

2826
def get_headers(self):
2927
jira_user = self.dataspace.get_configuration("jira_user")

workflow/integrations/sourcehut.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ def create_issue(self, repo_id, title, body=""):
9898
)
9999
return response.get("data", {}).get("submitTicket")
100100

101-
def update_issue(self, repo_id, issue_id, title=None, body=None, state=None, labels=None):
101+
def update_issue(self, repo_id, issue_id, title=None, body=None, state=None):
102102
"""Update an existing SourceHut ticket via GraphQL."""
103103
mutation = """
104104
mutation UpdateTicket($trackerId: Int!, $ticketId: Int!, $input: UpdateTicketInput!) {

0 commit comments

Comments
 (0)