diff --git a/templates/zerver/integrations/index.html b/templates/zerver/integrations/index.html index 526890a256..1fa596206e 100644 --- a/templates/zerver/integrations/index.html +++ b/templates/zerver/integrations/index.html @@ -116,63 +116,6 @@ {% include 'zerver/integrations/email.html' %} {% endif %} - -
- - -

If you are running JIRA version 5.2 or greater, or using the - hosted JIRA provided by Atlassian, we recommend using the web-hook method above instead. This plugin - supports older versions of JIRA.

- -

First, create the stream you'd like to use for JIRA notifications, and - subscribe all interested parties to this stream. We recommend the - name jira.

- -
Plugin mechanism
- Next, download and install our Python bindings and example scripts. -

Plugin Installation

- The JIRA integration plugin requires two JIRA plugins. Please install - the following plugins using the Universal Plugin Manager in your JIRA - installation: - -

SSL Setup

- As Zulip is using a StartCOM SSL certificate that is not recognized by default in the Java installation shipped with JIRA, - you will need to tell JIRA about the certificate. Navigate to Administration > System > Configure SSL and in - the Import SSL Certificates field, enter {{ external_api_uri_subdomain }}. After clicking Save Certificates, - follow the on-screen instructions and restart JIRA for it to recognize the proper certificates. -

Zulip Integration

- Copy the folder integrations/jira/org/ (from the tarball you downloaded above) to your JIRA classes folder. - For self-contained JIRA installations, this will be atlassian-jira/WEB-INF/classes/, but this may be different in your deployment. - Edit the constants at the top of org/zulip/jira/ZulipListener.groovy - and fill them with the appropriate values: -
String zulipEmail = "jira-notifications-bot@example.com"
-String zulipAPIKey = "0123456789abcdef0123456789abcdef"
-String zulipStream = "JIRA"
-String issueBaseUrl = "https://jira.COMPANY.com/browse/"
-
-

In the Administrators page, navigate to Plugins > Other > Script Listeners. In the Add Listener section, click on - the Custom Listener option. Select the events you wish the Zulip integration to fire for, and the projects you wish Zulip to be notified for. - In the Name of groovy class field, enter org.zulip.jira.ZulipListener. -

- -

Click Add Listener, and JIRA will now notify your Zulip of changes to your issues!

- -

Congratulations! You're done!
- Updates from JIRA will be sent to the stream you've configured, as below.

- - -

- 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. -

-
-

Get Zulip notifications when you hg push!

diff --git a/templates/zerver/integrations/jira-plugin.html b/templates/zerver/integrations/jira-plugin.html new file mode 100644 index 0000000000..ad5869dd4b --- /dev/null +++ b/templates/zerver/integrations/jira-plugin.html @@ -0,0 +1,63 @@ +

+ If you are running JIRA version 5.2 or greater, or using the + hosted JIRA provided by Atlassian, we recommend using the + web-hook method above instead. This plugin + supports older versions of JIRA. +

+ +

+ First, create the stream you'd like to use for JIRA notifications, and + subscribe all interested parties to this stream. We recommend the + name jira. +

+ +
Plugin mechanism
+Next, download and install our Python bindings and example scripts. +

Plugin Installation

+The JIRA integration plugin requires two JIRA plugins. Please install +the following plugins using the Universal Plugin Manager in your JIRA +installation: + +

SSL Setup

+As Zulip is using a StartCOM SSL certificate that is not recognized by default in the Java installation shipped with +JIRA, +you will need to tell JIRA about the certificate. Navigate to Administration > System > Configure SSL +and in +the Import SSL Certificates field, enter {{ external_api_uri_subdomain }}. After clicking +Save Certificates, +follow the on-screen instructions and restart JIRA for it to recognize the proper certificates. +

Zulip Integration

+Copy the folder integrations/jira/org/ (from the tarball you downloaded above) to your JIRA +classes +folder. +For self-contained JIRA installations, this will be atlassian-jira/WEB-INF/classes/, but this may be +different in your deployment. +Edit the constants at the top of org/zulip/jira/ZulipListener.groovy +and fill them with the appropriate values: +
String zulipEmail = "jira-notifications-bot@example.com"
+String zulipAPIKey = "0123456789abcdef0123456789abcdef"
+String zulipStream = "JIRA"
+String issueBaseUrl = "https://jira.COMPANY.com/browse/"
+
+
+

+ In the Administrators page, navigate to Plugins > Other > Script Listeners. In the + Add Listener section, click on + the Custom Listener option. Select the events you wish the Zulip integration to fire for, and the + projects you wish Zulip to be notified for. + In the Name of groovy class field, enter org.zulip.jira.ZulipListener. +

+ +

Click Add Listener, and JIRA will now notify your Zulip of changes to your issues!

+ +

+ Congratulations! You're done!
+ Updates from JIRA will be sent to the stream you've configured, as below. +

+ diff --git a/tools/check-templates b/tools/check-templates index 18fecf166b..f8c9079779 100755 --- a/tools/check-templates +++ b/tools/check-templates @@ -129,6 +129,7 @@ def check_html_templates(templates, all_dups): 'templates/zerver/integrations/capistrano.html', 'templates/zerver/integrations/git.html', + 'templates/zerver/integrations/jira-plugin.html', ] validate(fn=fn, check_indent=(fn not in bad_files)) @@ -186,6 +187,7 @@ def check_html_templates(templates, all_dups): 'templates/zerver/integrations/capistrano.html', 'templates/zerver/integrations/git.html', 'templates/zerver/integrations/google-calendar.html', + 'templates/zerver/integrations/jira-plugin.html', ] # TODO: Clean these files for fn in templates: diff --git a/zerver/lib/integrations.py b/zerver/lib/integrations.py index 6d3cd83881..3e4481eef4 100644 --- a/zerver/lib/integrations.py +++ b/zerver/lib/integrations.py @@ -206,7 +206,8 @@ INTEGRATIONS = { 'jira-plugin', logo='static/images/integrations/logos/jira.svg', secondary_line_text='(locally installed)', - display_name='JIRA' + display_name='JIRA', + doc='zerver/integrations/jira-plugin.html' ), 'mercurial': Integration('mercurial', 'mercurial', display_name='Mercurial (hg)'), 'nagios': Integration('nagios', 'nagios'),