CRAVEX SourceHut workflow integration #348

Signed-off-by: tdruez <tdruez@nexb.com>

Author: tdruez

dje/admin.py

@@ -1057,10 +1057,11 @@ class DataspaceConfigurationForm(forms.ModelForm):
         "scancodeio_api_key",
         "vulnerablecode_api_key",
         "purldb_api_key",
+        "forgejo_token",
         "github_token",
         "gitlab_token",
         "jira_token",
-        "forgejo_token",
+        "sourcehut_token",
     ]
 
     def __init__(self, *args, **kwargs):
@@ -1101,6 +1102,14 @@ class DataspaceConfigurationInline(DataspacedFKMixin, admin.StackedInline):
                 )
             },
         ),
+        (
+            "Forgejo Integration",
+            {
+                "fields": [
+                    "forgejo_token",
+                ]
+            },
+        ),
         (
             "GitHub Integration",
             {
@@ -1127,10 +1136,10 @@ class DataspaceConfigurationInline(DataspacedFKMixin, admin.StackedInline):
             },
         ),
         (
-            "Forgejo Integration",
+            "SourceHut Integration",
             {
                 "fields": [
-                    "forgejo_token",
+                    "sourcehut_token",
                 ]
             },
         ),

docs/index.rst

@@ -52,6 +52,7 @@ Welcome to the very start of your DejaCode journey!
     integrations-github
     integrations-gitlab
     integrations-jira
+    integrations-sourcehut
 
 .. toctree::
    :maxdepth: 1

docs/integrations-sourcehut.rst

@@ -0,0 +1,63 @@
+.. _integrations_sourcehut:
+
+SourceHut Integration
+=====================
+
+DejaCode's integration with SourceHut allows you to automatically forward
+**Workflow Requests** to SourceHut **tickets**.
+This behavior can be selectively applied to any **Request Template** of your choice.
+
+Prerequisites
+-------------
+
+- A **SourceHut project** hosted on https://todo.sr.ht that you want to integrate with
+  DejaCode.
+- A **SourceHut account** with API access and permission to create/edit tickets.
+
+SourceHut API Token
+-------------------
+
+To enable integration, you need a SourceHut **API token**.
+
+1. **Create a Token**:
+
+   - Go to https://meta.sr.ht/oauth2
+   - Under **Personal Access Tokens**, click **"Generate new token"**
+   - Set a clear description like ``DejaCode Integration`` in the "Comment" field
+   - Select only the ``todo.sr.ht`` > ``TICKETS`` scope
+   - **Generate token** and copy the token
+
+.. note::
+
+   It is recommended to **create a dedicated SourceHut user** with a clear, descriptive
+   name such as ``dejacode-integration``. This ensures that all SourceHut issues
+   managed by integration are clearly attributed to that user, improving traceability
+   and auditability.
+
+DejaCode Dataspace Configuration
+--------------------------------
+
+To use your SourceHut token in DejaCode:
+
+1. Go to the **Administration dashboard**
+2. Navigate to **Dataspaces**, and select your Dataspace
+3. Scroll to the **SourceHut Integration** section under **Configuration**
+4. Paste your SourceHut token in the **SourceHut token** field
+5. Save the form
+
+Activate SourceHut Integration on Request Templates
+---------------------------------------------------
+
+1. Go to the **Administration dashboard**
+2. Navigate to **Workflow** > **Request templates**
+3. Create or edit a Request Template in your Dataspace
+4. Set the **Issue Tracker ID** field to your SourceHut project URL, e.g.::
+
+       https://todo.sr.ht/~USERNAME/PROJECT_NAME
+
+Once the integration is configured:
+
+- New **Requests** using this template will be automatically pushed to SourceHut
+- Field updates (like title or priority) and **status changes** (e.g. closed) will be
+  synced
+- New **Comments** on a DejaCode Request will be propagated to the SourceHut ticket

workflow/admin.py

@@ -69,6 +69,7 @@ def clean_issue_tracker_id(self):
                     "• GitHub: https://github.com/ORG/REPO_NAME",
                     "• GitLab: https://gitlab.com/GROUP/PROJECT_NAME",
                     "• Jira: https://YOUR_DOMAIN.atlassian.net/projects/PROJECTKEY",
+                    "• SourceHut: https://todo.sr.ht/~USERNAME/PROJECT_NAME",
                 ]
             )
         return issue_tracker_id

workflow/integrations/__init__.py

@@ -13,13 +13,15 @@
 from workflow.integrations.github import GitHubIntegration
 from workflow.integrations.gitlab import GitLabIntegration
 from workflow.integrations.jira import JiraIntegration
+from workflow.integrations.sourcehut import SourceHutIntegration
 
 __all__ = [
     "BaseIntegration",
     "ForgejoIntegration",
     "GitHubIntegration",
     "GitLabIntegration",
     "JiraIntegration",
+    "SourceHutIntegration",
     "is_valid_issue_tracker_id",
     "get_class_for_tracker",
     "get_class_for_platform",
@@ -36,11 +38,14 @@
     r"/(?:projects|browse)/[A-Z][A-Z0-9]+(?:/[^/]*)*/*$"
 )
 
+SOURCEHUT_PATTERN = re.compile(r"^https://todo\.sr\.ht/~[^/]+/[^/]+/?$")
+
 ISSUE_TRACKER_PATTERNS = [
     FORGEJO_PATTERN,
     GITHUB_PATTERN,
     GITLAB_PATTERN,
     JIRA_PATTERN,
+    SOURCEHUT_PATTERN,
 ]
 
 
@@ -57,6 +62,8 @@ def get_class_for_tracker(issue_tracker_id):
         return JiraIntegration
     elif "forgejo" in issue_tracker_id:
         return ForgejoIntegration
+    elif "todo.sr.ht" in issue_tracker_id:
+        return SourceHutIntegration
 
 
 def get_class_for_platform(platform):
@@ -65,4 +72,5 @@ def get_class_for_platform(platform):
         "github": GitHubIntegration,
         "gitlab": GitLabIntegration,
         "jira": JiraIntegration,
+        "sourcehut": SourceHutIntegration,
     }.get(platform)

workflow/integrations/base.py

@@ -21,6 +21,8 @@ class BaseIntegration:
     """Base class for managing issue tracker integrations from DejaCode requests."""
 
     default_timeout = 10
+    open_status = "open"
+    closed_status = "closed"
 
     def __init__(self, dataspace, timeout=None):
         if not dataspace:
@@ -95,6 +97,11 @@ def patch(self, url, json=None):
     def post_comment(self, repo_id, issue_id, comment_body, base_url=None):
         raise NotImplementedError
 
+    def get_status(self, request):
+        if request.is_closed:
+            return self.closed_status
+        return self.open_status
+
     @staticmethod
     def make_issue_title(request):
         return f"[DEJACODE] {request.title}"

workflow/integrations/forgejo.py

@@ -19,9 +19,6 @@ class ForgejoIntegration(BaseIntegration):
     from DejaCode requests.
     """
 
-    open_status = "open"
-    closed_status = "closed"
-
     def get_headers(self):
         forgejo_token = self.dataspace.get_configuration("forgejo_token")
         if not forgejo_token:
@@ -46,7 +43,7 @@ def sync(self, request):
                 issue_id=external_issue.issue_id,
                 title=self.make_issue_title(request),
                 body=self.make_issue_body(request),
-                state=self.closed_status if request.is_closed else self.open_status,
+                state=self.get_status(request),
             )
         else:
             issue = self.create_issue(

workflow/integrations/github.py

@@ -20,8 +20,6 @@ class GitHubIntegration(BaseIntegration):
     """
 
     api_url = GITHUB_API_URL
-    open_status = "open"
-    closed_status = "closed"
 
     def get_headers(self):
         github_token = self.dataspace.get_configuration(field_name="github_token")
@@ -47,7 +45,7 @@ def sync(self, request):
                 issue_id=external_issue.issue_id,
                 title=self.make_issue_title(request),
                 body=self.make_issue_body(request),
-                state=self.closed_status if request.is_closed else self.open_status,
+                state=self.get_status(request),
                 labels=labels,
             )
         else:

workflow/integrations/gitlab.py

@@ -21,6 +21,8 @@ class GitLabIntegration(BaseIntegration):
     """
 
     api_url = GITLAB_API_URL
+    open_status = "reopen"
+    closed_status = "close"
 
     def get_headers(self):
         gitlab_token = self.dataspace.get_configuration(field_name="gitlab_token")
@@ -48,7 +50,7 @@ def sync(self, request):
                 issue_id=external_issue.issue_id,
                 title=self.make_issue_title(request),
                 body=self.make_issue_body(request),
-                state_event="close" if request.is_closed else "reopen",
+                state_event=self.get_status(request),
                 labels=labels,
             )
         else:

workflow/integrations/jira.py

@@ -22,6 +22,7 @@ class JiraIntegration(BaseIntegration):
     """
 
     issuetype = "DejaCode Request"
+    open_status = None
     closed_status = "Closed"
 
     def get_headers(self):
@@ -55,7 +56,7 @@ def sync(self, request):
                 issue_id=external_issue.issue_id,
                 title=self.make_issue_title(request),
                 body=self.make_issue_body(request),
-                status=self.closed_status if request.is_closed else None,
+                status=self.get_status(request),
             )
         else:
             issue = self.create_issue(