diff --git a/templates/zerver/integrations/codebase.html b/templates/zerver/integrations/codebase.html new file mode 100644 index 0000000000..8a15e6422a --- /dev/null +++ b/templates/zerver/integrations/codebase.html @@ -0,0 +1,53 @@ +

+ First, create the streams you'd like to use for Codebase notifications. There will be two types of + messages: commit-related updates and issue-related updates. After creating these streams (we suggest naming + them codebase commits and codebase issues), make sure to subscribe all interested + parties. +

+ +

+ Next, download and install our + Python bindings and example scripts on the computer you'd like to run this mirroring script from. +

+ +

+ You will need your Codebase API Username. You can find it in the settings page of your account, under + API Credentials. +

+

+ Edit the Codebase and Zulip credentials in integrations/codebase/zulip_codebase_config.py using + your favorite editor: +

+ + +
+ 
CODEBASE_API_USERNAME = "zulip-inc/leo-franchi-15"
+CODEBASE_API_KEY = 0123456789abcdef0123456789abcdef
+
+ZULIP_USER = "codebase-bot@example.com"
+ZULIP_API_KEY = "0123456789abcdef0123456789abcdef"
+{% if api_site_required %}ZULIP_SITE ="{{ external_api_uri_subdomain }}"{% endif %}
+
+ +

+ Before your first run of the script, you may optionally choose to + configure it to mirror some number of hours of prior Codebase activity: +

+ +
+ 
CODEBASE_INITIAL_HISTORY_HOURS = 10
+
+ +

+ Now, simply run the api/integrations/codebase/zulip_codebase_mirror script. + If needed, this script may be restarted, and it will automatically resume from when + it was last running. +

+ +

+ Congratulations! You're done!
Whenever you create a new project, + commit, issue, deployment, or more, you'll get notifications in your selected streams + with the associated information. +

+ diff --git a/templates/zerver/integrations/index.html b/templates/zerver/integrations/index.html index 160fcb29cb..3faf5de676 100644 --- a/templates/zerver/integrations/index.html +++ b/templates/zerver/integrations/index.html @@ -112,53 +112,6 @@ {% endif %} {% endfor %} -
- -

First, create the streams you'd like to use for Codebase notifications. There will be two types of - messages: commit-related updates and issue-related updates. After creating these streams (we suggest naming - them codebase commits and codebase issues), make sure to subscribe all interested parties.

- -

Next, download and install our Python - bindings and example scripts on the computer you'd like to run this mirroring script from.

- -

You will need your Codebase API Username. You can find it in the settings page of your account, under - API Credentials.

-

Edit the Codebase and Zulip credentials in integrations/codebase/zulip_codebase_config.py using - your favorite editor:

- - -
- 
CODEBASE_API_USERNAME = "zulip-inc/leo-franchi-15"
-CODEBASE_API_KEY = 0123456789abcdef0123456789abcdef
-
-ZULIP_USER = "codebase-bot@example.com"
-ZULIP_API_KEY = "0123456789abcdef0123456789abcdef"
-{% if api_site_required %}ZULIP_SITE = "{{ external_api_uri_subdomain }}"{% endif %}
-
- -

Before your first run of the script, you may optionally choose to - configure it to mirror some number of hours of prior Codebase activity:

- -
- 
CODEBASE_INITIAL_HISTORY_HOURS = 10
-
- -

Now, simply run the api/integrations/codebase/zulip_codebase_mirror script. - If needed, this script may be restarted, and it will automatically resume from when - it was last running.

- -

Congratulations! You're done!
Whenever you create a new project, - commit, issue, deployment, or more, you'll get notifications in your selected streams - with the associated information.

- - -

- Logos are trademarks of their respective owners. - None of the integrations on this page are created by, - affiliated with, or supported by the companies - represented by the logos. -

-
{% if email_integration_enabled %}
diff --git a/zerver/lib/integrations.py b/zerver/lib/integrations.py index 3fda5e5021..d87f414b08 100644 --- a/zerver/lib/integrations.py +++ b/zerver/lib/integrations.py @@ -185,7 +185,7 @@ WEBHOOK_INTEGRATIONS = [ INTEGRATIONS = { 'asana': Integration('asana', 'asana', doc='zerver/integrations/asana.html'), 'capistrano': Integration('capistrano', 'capistrano', doc='zerver/integrations/capistrano.html'), - 'codebase': Integration('codebase', 'codebase'), + 'codebase': Integration('codebase', 'codebase', doc='zerver/integrations/codebase.html'), 'email': EmailIntegration('email', 'email'), 'git': Integration('git', 'git'), 'google-calendar': Integration('google-calendar', 'google-calendar', display_name='Google Calendar'),