Discourse Jira

[Discourse]

	Summary	Discourse Jira synchronizes projects, issue types, fields, issue statuses and manages the issues.
	Repository Link	https://github.com/discourse/discourse-jira
	Install Guide	How to install plugins in Discourse

As this is an official plugin maintained by the Discourse team, Support, Contribute > Bug, Contribute > UX, and Contribute > Feature requests can be made in the respective categories here on Meta, and tagged with the appropriate plugin tag. Click on a link below to get one started.

 Support  Bug  UX  Feature

Features

• Jira projects, issue types, fields and field options will be synced automatically.
• Create a new Jira issue for a Discourse post with the dynamic issue creation form.
• Attach an existing Jira issue to a Discourse post.
• Sync the status of Jira issue using the webhooks.

Screenshots

Post Menu

Configuration

Set the values for site settings below before enabling the plugin.

• discourse_jira_url: Put the URL of your Jira instance. It should end with / symbol.
• discourse_jira_username: The username of the user whose behalf of going to create issues.
• discourse_jira_password: The API key that is assigned to the user who creates issues. A password might work but is unsafe and the API was deprecated by Atlassian.
• discourse_jira_enabled: Enable the Jira plugin for Discourse.
• discourse_jira_allowed_groups: Select groups to have access to the Jira plugin features. Defaults to admin and mods.

Webhook

Set a secret token to verify the incoming webhooks from Jira.

• discourse_jira_webhook_token: This token must be passed in the ‘t’ query parameter of the webhook.

For example, given that the webhook token is supersecret, and your base Discourse URL is discourse.example.com, you would set up the webhook URL as https://discourse.example.com/jira/issues/webhook?t=supersecret in the webhook settings for your Jira instance.

For just checking that the webhook is triggered and the emitted body is correct, you may opt to use external websites like RequestBin or Webhook.site to setup temporary webhook URLs.

Debugging

discourse_jira_verbose_log: Enable this setting to log the payloads of both the incoming webhooks and outgoing API requests.

Hosted by us? This plugin is available on our Enterprise plan.

Last edited by @benji 2024-08-22T20:44:40Z

Check document

Perform check on document:

[jordan-violet]

@vinothkannans we’ve noticed that our users cannot actually see the status of these tickets, that only admins can see them. Can anything be done to make the “status” more visible to users?

One option could be of course making that quote block visible, or it would also be nice if you could map Jira statuses to tags, and that the topic tag updated to reflect the ticket progress (#backlog, #in-progress, #complete, etc.).

[colin.mckibben]

@jordan-violet

@vinothkannans we’ve noticed that our users cannot actually see the status of these tickets, that only admins can see them. Can anything be done to make the “status” more visible to users?

To piggy back off of Jordan, I have some additional ideas to improve this plugin.

1. Ability to detach a JIRA ticket. I don’t see an option to detach or delete a JIRA ticket that I linked to a post.
2. Choose which groups can see attached JIRA tickets. Right now it only looks like site admins can see them, but we would like the option to select one or more additional groups that can see them.
3. Visibility levels. Ability to specify which part(s) of the ticket will appear to non-admins. For example, maybe we want all groups to see the ticket number and status, but not the title of the ticket, which may contain sensitive information. Then, we can specify trusted groups that can see the ticket title.

[nathank (Nathan Kershaw)]

Your suggestions would really enhance the experience with this plugin.

We really need to have the content be able to be revealed to a specified group (that isn’t admins).

[polyzium]

Is there a OpenProject version of this? Would be great to have since we use OpenProject for managing our tasks.

[vinothkannans (Vinoth Kannan)]

@jordan-violet @colin.mckibben these are good suggestions to make the plugin more useful. I will keep this in mind when I work on it next time.

[ckshen]

Hi, I have a question about configuring the plugin. I have been getting 500 errors when creating/ attaching issue so I think my settings are not entirely right. What did i do wrong?

First, I copied and pasted where I normally accessed my Jira instance into discourse jira url, although I am not completely certain about the URL since dependent on the selected Jira view the URL is different.

First, I set a random discourse jira username, with the discourse jira password copied and pasted from a generated Atlassian API token.

---

---

Then I added a Jira Webhook and set the URL of the Jira webhook to the URL of my discourse instance plus /jira/issues/webhook?t=

Then I set the Webhook secret, and copy and paste that secret back to the plugin config field discourse jira webhook token.

Any thoughts? Help much appreciated! Thanks.

[ckshen]

Can anyone share your working plugin settings in Discourse (without the password/ token of course) so I can see how you get it to work? Thanks!

[mikael.gundhus]

I copied the webhook token back into the URL in the Jira webhook setup, so it says https://example.com/jira/issues/webhook?t=abcdefghijk, and also your discourse_jira_url is supposed to be https://modernsquared.atlassian.net/ without the path.

@vinothkannans I have another question though: Is it possible to change which issue is attached to a topic after attaching, or simply remove/delete the attachment? If not, have you thought about implementing it?

[ckshen]

@mikael.gundhus

I copied the webhook token back into the URL in the Jira webhook setup, so it says https://example.com/jira/issues/webhook?t=abcdefghijk, and also your discourse_jira_url is supposed to be https://modernsquared.atlassian.net/ without the path.

Thanks @mikael.gundhus , I was able to get the plugin to connect to Jira.

But I ran into some oddity. I am not sure if I am the only one running into this issue, but the button Create and Attach issues seems to be reversed? When I click on the Create Issue button the plugin takes me to the attach issue screen:

And when I click on the Attach issue button the plugin takes me to the create issue screen: MS-155 is an existing issue in Jira. If I type in a new issue, say, MS-200, which doesn’t exist in Jira, it tells me An error occurred: You are not permitted to view the requested resource.

[vinothkannans (Vinoth Kannan)]

@mikael.gundhus yes, there should be an option to remove the existing attachment. @ckshen seems like it have wrong headings on modal windows. We will work on these in next iteration.

[putty]

Are there plans to make this accessible to users who aren’t admins/mods? We have internal teams that are looking to move their operations to Discourse, and as it stands, the only way for them to use the JIra tool is by giving them site-wide moderation privileges.

[benji]

I’ve just updated this plugin with Group permissions! It defaults to and must always include Admins, but with this update users can now make Jira tickets without needing to be Admin-level. Enjoy!

[Adam_Skalicky]

Hey Folks,

Has anyone successfully got this plugin working with Jira server or Datacenter?

I am not seeing any attachment option and seeing an error in the logs.

Job exception: DiscourseJira::InvalidURI

[nat (Natalie T)]

So far we’ve only built this plugin using APIs for Jira Cloud. So you might not be successful with Jira DC.

Jira Cloud REST doc: https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issues/#api-rest-api-2-issue-createmeta-get
Jira DC/Server REST doc: https://developer.atlassian.com/server/jira/platform/jira-rest-api-examples

[Adam_Skalicky]

Thanks Natalie, after adding our host to the allowed internal hosts under Security, we were able to link and create issues. This probably is helpful to know for anyone using an internal instance of Jira. Still working on comment sync but I believe that is a config issue.

[gamallear]

Does this feature work with Jira Service Management Projects as well?

[Moin]

Seems there is an incompatibility between jira and reactions

Unable to use reactions on IOS/Mobile

Hello The issue is that the Discourse Jira plugin adds position: relative to .post-controls .actions. However, this doesn’t work because nav.post-controls has overflow-x: auto, which clips any overflowed (floating) elements — such as those added by Discourse Reactions. This only happens on mobile (viewport.sm), because overflow-x: auto is applied there.

[el.duderino (You know who I am.)]

I have tried this on our self-hosted jira datacentre instance, but seem to be stuck - I would really appreciate it if you could help.

TL;DR - I’m getting a 403 and HTML returned when it should be giving a 201 and JSON:

`/var/www/discourse/plugins/discourse-jira/lib/discourse_jira/api.rb:63:in ‘DiscourseJira::Api.getJSON’`

• I have created the Jira Personal Access Token
• I have tried several paths for the API : /, /rest,/rest/api, /rest/api/latest I have checked that the last one works.
• No matter what I keep getting returned HTML instead of JSON.

I suspect I’m doing something wrong with the plugin configuration, but I can’t tell what. If anyone has gotten this to work with JIRA datacentre, I’d love to pick you brains!

Thanks

Bruce