snapshot of https://github.com/zulip/zulip.git @ 48c69911c7dd4e03b20552eb3bd77ad8151c1357 (2026-09-15)

zerver/webhooks/codeship/doc.md

@@ -0,0 +1,33 @@
+# Zulip Codeship integration
+
+Get notifications about Codeship build statuses in Zulip.
+
+{start_tabs}
+
+1. {!create-an-incoming-webhook.md!}
+
+1. {!generate-webhook-url-basic.md!}
+
+1. On your project's webpage, click on **Project Settings** in
+   the top right corner.
+
+1. Select the **Notifications** tab, and then select
+   **+ New Notification**.
+
+1. Select **Webhook**, and set **Webhook URL** to the URL generated
+   above.
+
+1. _(optional)_ You may also supply an optional description or a
+   specific branch you would like to be notified about.
+
+1. Select **Save**.
+
+{end_tabs}
+
+{!congrats.md!}
+
+![](/static/images/integrations/codeship/001.png)
+
+### Related documentation
+
+{!webhooks-url-specification.md!}

zerver/webhooks/codeship/fixtures/error_build.json

@@ -0,0 +1,16 @@
+{
+  "build": {
+    "build_url":"https://www.codeship.com/projects/10213/builds/973711",
+    "commit_url":"https://github.com/codeship/docs/commit/96943dc5269634c211b6fbb18896ecdcbd40a047",
+    "project_id":10213,
+    "build_id":973711,
+    "status":"error",
+    "project_full_name":"codeship/docs",
+    "project_name":"codeship/docs",
+    "commit_id":"96943dc5269634c211b6fbb18896ecdcbd40a047",
+    "short_commit_id":"96943",
+    "message":"Merge pull request #34 from codeship/feature/shallow-clone",
+    "committer":"beanieboi",
+    "branch":"master"
+  }
+}

zerver/webhooks/codeship/fixtures/other_status_build.json

@@ -0,0 +1,16 @@
+{
+  "build": {
+    "build_url":"https://www.codeship.com/projects/10213/builds/973711",
+    "commit_url":"https://github.com/codeship/docs/commit/96943dc5269634c211b6fbb18896ecdcbd40a047",
+    "project_id":10213,
+    "build_id":973711,
+    "status":"some_other_status",
+    "project_full_name":"codeship/docs",
+    "project_name":"codeship/docs",
+    "commit_id":"96943dc5269634c211b6fbb18896ecdcbd40a047",
+    "short_commit_id":"96943",
+    "message":"Merge pull request #34 from codeship/feature/shallow-clone",
+    "committer":"beanieboi",
+    "branch":"master"
+  }
+}

zerver/webhooks/codeship/fixtures/success_build.json

@@ -0,0 +1,16 @@
+{
+  "build": {
+    "build_url":"https://www.codeship.com/projects/10213/builds/973711",
+    "commit_url":"https://github.com/codeship/docs/commit/96943dc5269634c211b6fbb18896ecdcbd40a047",
+    "project_id":10213,
+    "build_id":973711,
+    "status":"success",
+    "project_full_name":"codeship/docs",
+    "project_name":"codeship/docs",
+    "commit_id":"96943dc5269634c211b6fbb18896ecdcbd40a047",
+    "short_commit_id":"96943",
+    "message":"Merge pull request #34 from codeship/feature/shallow-clone",
+    "committer":"beanieboi",
+    "branch":"master"
+  }
+}

zerver/webhooks/codeship/fixtures/testing_build.json

@@ -0,0 +1,16 @@
+{
+  "build": {
+    "build_url":"https://www.codeship.com/projects/10213/builds/973711",
+    "commit_url":"https://github.com/codeship/docs/commit/96943dc5269634c211b6fbb18896ecdcbd40a047",
+    "project_id":10213,
+    "build_id":973711,
+    "status":"testing",
+    "project_full_name":"codeship/docs",
+    "project_name":"codeship/docs",
+    "commit_id":"96943dc5269634c211b6fbb18896ecdcbd40a047",
+    "short_commit_id":"96943",
+    "message":"Merge pull request #34 from codeship/feature/shallow-clone",
+    "committer":"beanieboi",
+    "branch":"master"
+  }
+}

zerver/webhooks/codeship/tests.py

@@ -0,0 +1,33 @@
+from zerver.lib.test_classes import WebhookTestCase
+
+
+class CodeshipHookTests(WebhookTestCase):
+    TOPIC_NAME = "codeship/docs"
+
+    def test_codeship_build_in_testing_status_message(self) -> None:
+        """
+        Tests if codeship testing status is mapped correctly
+        """
+        expected_message = "[Build](https://www.codeship.com/projects/10213/builds/973711) triggered by beanieboi on master branch started."
+        self.check_webhook("testing_build", self.TOPIC_NAME, expected_message)
+
+    def test_codeship_build_in_error_status_message(self) -> None:
+        """
+        Tests if codeship error status is mapped correctly
+        """
+        expected_message = "[Build](https://www.codeship.com/projects/10213/builds/973711) triggered by beanieboi on master branch failed."
+        self.check_webhook("error_build", self.TOPIC_NAME, expected_message)
+
+    def test_codeship_build_in_success_status_message(self) -> None:
+        """
+        Tests if codeship success status is mapped correctly
+        """
+        expected_message = "[Build](https://www.codeship.com/projects/10213/builds/973711) triggered by beanieboi on master branch succeeded."
+        self.check_webhook("success_build", self.TOPIC_NAME, expected_message)
+
+    def test_codeship_build_in_other_status_status_message(self) -> None:
+        """
+        Tests if codeship other status is mapped correctly
+        """
+        expected_message = "[Build](https://www.codeship.com/projects/10213/builds/973711) triggered by beanieboi on master branch has some_other_status status."
+        self.check_webhook("other_status_build", self.TOPIC_NAME, expected_message)

zerver/webhooks/codeship/view.py

@@ -0,0 +1,59 @@
+# Webhooks for external integrations.
+from django.http import HttpRequest, HttpResponse
+
+from zerver.decorator import webhook_view
+from zerver.lib.response import json_success
+from zerver.lib.typed_endpoint import JsonBodyPayload, typed_endpoint
+from zerver.lib.validator import WildValue, check_string
+from zerver.lib.webhooks.common import check_send_webhook_message
+from zerver.models import UserProfile
+
+CODESHIP_TOPIC_TEMPLATE = "{project_name}"
+CODESHIP_MESSAGE_TEMPLATE = (
+    "[Build]({build_url}) triggered by {committer} on {branch} branch {status}."
+)
+
+CODESHIP_DEFAULT_STATUS = "has {status} status"
+CODESHIP_STATUS_MAPPER = {
+    "testing": "started",
+    "error": "failed",
+    "success": "succeeded",
+}
+
+
+@webhook_view("Codeship")
+@typed_endpoint
+def api_codeship_webhook(
+    request: HttpRequest,
+    user_profile: UserProfile,
+    *,
+    payload: JsonBodyPayload[WildValue],
+) -> HttpResponse:
+    payload = payload["build"]
+    topic_name = get_topic_for_http_request(payload)
+    body = get_body_for_http_request(payload)
+
+    check_send_webhook_message(request, user_profile, topic_name, body)
+    return json_success(request)
+
+
+def get_topic_for_http_request(payload: WildValue) -> str:
+    return CODESHIP_TOPIC_TEMPLATE.format(
+        project_name=payload["project_name"].tame(check_string),
+    )
+
+
+def get_body_for_http_request(payload: WildValue) -> str:
+    return CODESHIP_MESSAGE_TEMPLATE.format(
+        build_url=payload["build_url"].tame(check_string),
+        committer=payload["committer"].tame(check_string),
+        branch=payload["branch"].tame(check_string),
+        status=get_status_message(payload),
+    )
+
+
+def get_status_message(payload: WildValue) -> str:
+    build_status = payload["status"].tame(check_string)
+    return CODESHIP_STATUS_MAPPER.get(
+        build_status, CODESHIP_DEFAULT_STATUS.format(status=build_status)
+    )