Add "Create Done Status" in docs #350

Signed-off-by: tdruez <[email protected]>

Author: tdruez

docs/integrations-jira.rst

@@ -14,7 +14,7 @@ Prerequisites
 - A **Jira user account** with sufficient permissions
   (at least *Create Issues* and *Edit Issues*) in that project.
 
-Create Custom *DejaCode Request* Work Type
+Create Custom "DejaCode Request" Work Type
 ------------------------------------------
 
 .. warning::
@@ -28,6 +28,27 @@ To create the custom work type in Jira:
 3. Set the name to: ``DejaCode Request``
 4. Click **Create**
 
+Create "Done" Status
+--------------------
+
+.. warning::
+
+   This is required for the integration to function properly.
+
+This status will be set on the Jira issue when the DejaCode Request is closed.
+
+To create the **Done** status in Jira:
+
+1. Navigate to **Project settings** → **Work types**
+2. Select the ``DejaCode Request`` work type
+3. Click **Edit workflow**
+4. Click **Add status**
+5. Click **Create new status** tab
+6. Enter the name: ``Done``
+7. Choose a category: ``Done``
+8. Click **Add**
+9. Click **Update workflow**
+
 Jira API Token
 --------------
 

workflow/integrations/jira.py

@@ -21,7 +21,8 @@ class JiraIntegration(BaseIntegration):
     from DejaCode requests.
     """
 
-    default_issuetype = "DejaCode Request"
+    issuetype = "DejaCode Request"
+    closed_status = "Done"
 
     def get_headers(self):
         jira_user = self.dataspace.get_configuration("jira_user")
@@ -54,7 +55,7 @@ def sync(self, request):
                 issue_id=external_issue.issue_id,
                 title=self.make_issue_title(request),
                 body=self.make_issue_body(request),
-                status="Done" if request.is_closed else None,
+                status=self.closed_status if request.is_closed else None,
             )
         else:
             issue = self.create_issue(
@@ -76,7 +77,7 @@ def create_issue(self, project_key, title, body=""):
                 "project": {"key": project_key},
                 "summary": title,
                 "description": markdown_to_adf(body),
-                "issuetype": {"name": self.default_issuetype},
+                "issuetype": {"name": self.issuetype},
             }
         }
         return self.post(url, json=data)
@@ -112,6 +113,7 @@ def transition_issue(self, issue_id, target_status_name):
         response_json = self.get(url=transitions_url)
         transitions = response_json.get("transitions", [])
 
+        # Search for a transition name that match the `target_status_name`
         for transition in transitions:
             if transition["to"]["name"].lower() == target_status_name.lower():
                 transition_id = transition["id"]