jira-plugin: Use create-stream macro and improve Markdown.

This commit is contained in:
Eeshan Garg
2017-06-19 23:03:39 -02:30
committed by showell
parent 70448a9c65
commit 169d7393a6
2 changed files with 35 additions and 35 deletions

View File

@@ -1,21 +1,19 @@
_If you are running JIRA version 5.2 or greater, or using the hosted *If you are running JIRA version 5.2 or greater, or using the hosted
JIRA provided by Atlassian, we recommend using the JIRA provided by Atlassian, we recommend using the
[web-hook method](#jira) above instead. This plugin supports older [web-hook method](#jira) above instead. This plugin supports older
versions of JIRA._ versions of JIRA.*
First, create the stream you'd like to use for JIRA notifications, and {!create-stream.md!}
subscribe all interested parties to this stream. We recommend the name
`jira`.
##### Plugin mechanism ### Plugin mechanism
{!download-python-bindings.md!} {!download-python-bindings.md!}
**Plugin Installation** #### Plugin Installation
The JIRA integration plugin requires two JIRA plugins. Please install The JIRA integration plugin requires two JIRA plugins. Please install
the following plugins using the Universal Plugin Manager in your JIRA the following plugins using the **Universal Plugin Manager** in your
installation: JIRA installation:
* [Script Runner Plugin][script-runner] * [Script Runner Plugin][script-runner]
* [SSL Plugin][ssl-plugin] * [SSL Plugin][ssl-plugin]
@@ -23,20 +21,20 @@ installation:
[script-runner]: https://marketplace.atlassian.com/plugins/com.onresolve.jira.groovy.groovyrunner [script-runner]: https://marketplace.atlassian.com/plugins/com.onresolve.jira.groovy.groovyrunner
[ssl-plugin]: https://marketplace.atlassian.com/plugins/com.atlassian.jira.plugin.jirasslplugin [ssl-plugin]: https://marketplace.atlassian.com/plugins/com.atlassian.jira.plugin.jirasslplugin
**SSL Setup** #### SSL Setup
As Zulip is using a StartCOM SSL certificate that is not recognized by 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 default in the Java installation shipped with JIRA, you will need to
tell JIRA about the certificate. tell JIRA about the certificate.
1. Navigate to `Administration > System > Configure SSL` and in the 1. Navigate to **Administration > System > Configure SSL** and in the
`Import SSL Certificates` field, enter `{{ external_api_uri_subdomain }}`. **Import SSL Certificates** field, enter `{{ external_api_uri_subdomain }}`.
2. After clicking `Save Certificates`, follow the on-screen 2. After clicking **Save Certificates**, follow the on-screen
instructions and restart JIRA for it to recognize the proper instructions and restart JIRA for it to recognize the proper
certificates. certificates.
**Zulip Integration** #### Zulip Integration
1. Copy the folder `integrations/jira/org/` (from the tarball you 1. Copy the folder `integrations/jira/org/` (from the tarball you
downloaded above) to your JIRA `classes` folder. For self-contained downloaded above) to your JIRA `classes` folder. For self-contained
@@ -50,20 +48,21 @@ appropriate values:
``` Python ``` Python
String zulipEmail = "jira-notifications-bot@example.com" String zulipEmail = "jira-notifications-bot@example.com"
String zulipAPIKey = "0123456789abcdef0123456789abcdef" String zulipAPIKey = "0123456789abcdef0123456789abcdef"
String zulipStream = "JIRA" String zulipStream = "{{ recommended_stream_name }}"
String issueBaseUrl = "https://jira.COMPANY.com/browse/" String issueBaseUrl = "https://jira.COMPANY.com/browse/"
``` ```
3. In the Administrators page, navigate to `Plugins > Other > Script Listeners`. 3. On the **Administrators** page, navigate to
**Plugins > Other > Script Listeners**.
4. In the `Add Listener` section, click on the `Custom Listener` 4. In the **Add Listener** section, click on the **Custom Listener**
option. Select the events you wish the Zulip integration to fire for, option. Select the events you wish the Zulip integration to fire for,
and the projects you wish Zulip to be notified for. and the projects you wish Zulip to be notified for.
5. In the `Name of groovy class` field, enter 5. In the **Name of groovy class** field, enter
`org.zulip.jira.ZulipListener`. `org.zulip.jira.ZulipListener`.
6. Click `Add Listener`, and JIRA will now notify your Zulip of 6. Click **Add Listener**, and JIRA will now notify your Zulip of
changes to your issues! Updates from JIRA will be sent to the stream changes to your issues! Updates from JIRA will be sent to the stream
you've configured. you've configured.

View File

@@ -273,7 +273,8 @@ INTEGRATIONS = {
logo='static/images/integrations/logos/jira.svg', logo='static/images/integrations/logos/jira.svg',
secondary_line_text='(locally installed)', secondary_line_text='(locally installed)',
display_name='JIRA', display_name='JIRA',
doc='zerver/integrations/jira-plugin.md' doc='zerver/integrations/jira-plugin.md',
stream_name='jira',
), ),
'mercurial': Integration( 'mercurial': Integration(
'mercurial', 'mercurial',