paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-10-31 12:03:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

integration-docs: Add Git integration screenshot config and image.

Browse Source 
Temporarily exclude Git from `test_integration_doc_endpoints`,
until the doc is updated.

The screenshot for this integration is added separately since this
adds a new screenshot for an integration whose doc is in the
python-zulip-api repo.
Since this breaks the sync between the docs and the screenshots, an
exclusion is added to make the tests pass.
This commit is contained in:
Niloth P
2025-10-02 17:22:39 +05:30
committed by Tim Abbott
parent f6e847d026
commit f317af2e1d
4 changed files with 12 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

BIN
static/images/integrations/git/001.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 61 KiB

3
zerver/lib/integrations.py
View File

@@ -70,6 +70,7 @@ FIXTURELESS_INTEGRATIONS_WITH_SCREENSHOTS: list[str] = [
"capistrano", "capistrano",
"codebase", "codebase",
"discourse", "discourse",
"git",
"github-actions", "github-actions",
"google-calendar", "google-calendar",
"jenkins", "jenkins",
@@ -749,8 +750,6 @@ NO_SCREENSHOT_CONFIG = (
# the integration is planned to be removed # the integration is planned to be removed
"twitter", "twitter",
} }
# Python API Integrations that do not currently have screenshots in docs
| {"git"}
| NO_SCREENSHOT_WEBHOOKS | NO_SCREENSHOT_WEBHOOKS
| hubot_integration_names | hubot_integration_names
) )

2
zerver/tests/test_docs.py
View File

@@ -417,7 +417,7 @@ class DocPageTest(ZulipTestCase):
# for the PythonAPIIntegrations, so we cannot avoid going out of sync # for the PythonAPIIntegrations, so we cannot avoid going out of sync
# when adding/deleting screenshots. # when adding/deleting screenshots.
# Use this set to temporarily add exclusions to this test. # Use this set to temporarily add exclusions to this test.
exception_images: set[str] = {"jira-plugin/001.png"} exception_images: set[str] = {"jira-plugin/001.png", "git/001.png"}
images_in_dir.update(exception_images) images_in_dir.update(exception_images)
images_in_docs.update(exception_images) images_in_docs.update(exception_images)

10
zerver/webhooks/fixtureless_integrations.py
View File

@@ -14,9 +14,11 @@ THREE_DIGIT_NUMBER = "492"
# Example user content # Example user content
BO_NAME = "Bo Williams" BO_NAME = "Bo Williams"
BO_EMAIL = "bwilliams@example.com"
BO_GIT_NAME = "bo-williams" BO_GIT_NAME = "bo-williams"
KEVIN_NAME = "Kevin Lin" KEVIN_NAME = "Kevin Lin"
KEVIN_EMAIL = "klin@example.com"
# Example project content # Example project content
PROJECT_NAME = "Example Project" PROJECT_NAME = "Example Project"
@@ -85,6 +87,14 @@ DISCOURSE = ScreenshotContent(
> {COMMIT_BODY_A}""", > {COMMIT_BODY_A}""",
) )
GIT = ScreenshotContent(
topic=BRANCH_GIT,
content=f"""`{DEPLOYMENT_HASH[:12]}` was deployed to `{BRANCH_GIT}` with:
* {KEVIN_EMAIL} - {COMMIT_HASH_A[:7]}: {COMMIT_MESSAGE_A}
* {BO_EMAIL} - {COMMIT_HASH_B[:7]}: {COMMIT_MESSAGE_B}
""",
)
GITHUB_ACTIONS = ScreenshotContent( GITHUB_ACTIONS = ScreenshotContent(
topic="scheduled backups", topic="scheduled backups",
content=f"""Backup [failed]() at {DATETIME_STAMP}. content=f"""Backup [failed]() at {DATETIME_STAMP}.