Bug 997203 - RFE - Support JIRA for "Report a bug" links
RFE - Support JIRA for "Report a bug" links
Product: PressGang CCMS
Classification: Community
Component: CSProcessor (Show other bugs)
Unspecified Unspecified
unspecified Severity high
: ---
: ---
Assigned To: Lee Newson
Depends On:
  Show dependency treegraph
Reported: 2013-08-14 19:32 EDT by Misty Stanley-Jones
Modified: 2014-06-18 03:05 EDT (History)
4 users (show)

See Also:
Fixed In Version: 1.0.0
Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of:
Last Closed: 2013-11-07 21:19:10 EST
Type: Bug
Regression: ---
Mount Type: ---
Documentation: ---
Verified Versions:
Category: ---
oVirt Team: ---
RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: ---

Attachments (Terms of Use)

  None (edit)
Description Misty Stanley-Jones 2013-08-14 19:32:46 EDT
WFK has moved to JIRA and made their Bugzilla instance read-only. This means that Report a Bug links in WFK docs no longer work. Please work with Sneha and Petr, the WFK writers, to determine which fields need to be set via the content spec and how to form the URLs. 

Also, please consider making the BZ and JIRA  base URLs configurable. I wonder if we should support Github or Google Code issue tracking as well. If you guys decide this is possibly in scope, please clone this RFE accordingly.

While this is important, it is not urgent. Please prioritize it to fit in with the rest of your work.
Comment 2 Lee Newson 2013-08-16 02:56:27 EDT
I've taken a better look into what is involved with this and unfortunately it's not going to be as easy as Bugzilla, however still doable without too much effort.

Firstly, since the required elements for the URL are ids and not names that means we'll have to do a look up. To do this we'll either have to make the users enter the key as the project (ie WFK2), or get them to enter a name and then pull down all the projects and find the matching project name. We'd have to do something similar with component, however it can be obtained easier from the project.

Secondly, as far as I can see there is no way to validate the labels, unlike keywords in Bugzilla. In saying that though that doesn't look like it'll be an issue as you can put any label, even if it's not a recommended one.

Thirdly, we'd have to create our own REST wrapper or do the calls using plain HTTP calls, as I was unable to find a library that wouldn't clash (the JIRA once uses Jersey and much older components than we are using).

All those points however aren't blockers in anyway. The third point being the one that will take the longest to implement.
Comment 3 Lee Newson 2013-08-16 02:57:29 EDT
REST API Docs: https://docs.atlassian.com/jira/REST/latest/
Comment 4 Petr Penicka 2013-08-16 10:05:01 EDT
Hi Lee, I already managed to create a URL in one of our books, staged at [1]. 

1) I used JIRA CLI [2] to obtain the IDs, it was pretty easy.

2) Why would you want to validate the labels. If you provide the "docs" label as part of the URL, as I did in [1], that's all we need. Or am I missing something?

3) I don't understand why you need REST calls. Do you want to obtain the IDs and stuff automatically? Wouldn't it be better if you just let us create a topic and the default feedback section with it, the same as I did in [1]?

[1] http://documentation-devel.engineering.redhat.com/docs/en-US/Red_Hat_JBoss_Web_Framework_Kit/2.4/html/Errai_Quickstart_Guide/jboss-feedback.html
[2] https://marketplace.atlassian.com/plugins/org.swift.jira.cli
Comment 5 Petr Penicka 2013-08-16 10:06:03 EDT
EDIT: in 3) above, I meant "... and override the default feedback section with it"
Comment 6 Lee Newson 2013-08-17 04:47:04 EDT
This has little to do with a feedback topic and is specific to the "Report a Bug" links below each topic, but yes you could do that if you wanted.

As for one, that is too complex for some and they won't understand. It would be much simpler, if they can just specify the Project/Component names which they can easily see.

For 2 you may want to specify something other than docs or perhaps something extra so it needs to be configurable, so as with all user input it'll need to be validated.

For 3 to do both 1 and 2 you'll need access to the REST API to do that.
Comment 7 Misty Stanley-Jones 2013-08-18 20:25:28 EDT
Petr, Lee is correct, these are two separate issues. The Feedback one is already solved well enough, for the most part.

Lee, I don't think keywords need validation in JIRA. Assuming that the book had the product, component, and keywords set in the spec (just like in Bugzilla), rather than detected automatically, can you please estimate how many ideal hours it would take to do this RFE?
Comment 8 Lee Newson 2013-08-18 20:35:43 EDT
Yeah you are correct Misty, labels can be any String. I found that out when I wrote a REST Client that uses RESTEasy on the weekend (see https://github.com/lnewson/JIRARESTClient).

As for an estimate it primarily depends on a couple of things I'd need to discuss with Matt (which I'll do during the weekly meeting tomorrow) but I'd say about 3 hours, given that I've already done the hard part.
Comment 9 Petr Penicka 2013-08-22 10:55:55 EDT
Right, now I see this being two different issues. Sorry, I was not getting the whole picture.

We will stick with overriding the Feedback topic for now, and switch to automated when it's available. As for the "Report a Bug" links, our next release is scheduled for mid-November, so it'd be fine having it implemented by then. 

Thanks for the additional info.
Comment 10 Lee Newson 2013-08-28 00:38:45 EDT
Added in csprocessor 1.0.0.

The new Meta Data elements are:

JIRAServer = <JIRA Server URL>
JIRAProject = <JIRA Project Name, Key or ID>
JIRAComponent = <JIRA Component Name or ID>
JIRAVersion = <JIRA Version Name or ID>
JIRALabels = <comma separated list of labels>

The Server and Project are the only compulsory elements.


JIRAServer = https://issues.jboss.org/
JIRAProject = WFK2
JIRAComponent = Errai

These elements will be validated and produce warnings if the content cannot be found. Upon building if the elements can't be found then a build exception will be thrown.
Comment 11 Lee Newson 2013-09-13 02:09:16 EDT
Petr pointed out today that I've missed something very important. To switch from using Bugzilla Bug Links to JIRA, you need to add/change the following metadata option:

Bug Links = JIRA
Comment 12 Lee Newson 2013-11-07 21:19:10 EST
Going to mark this as complete since it released fully in 1.2 and I know some people are currently using it.

Note You need to log in before you can comment on or make changes to this bug.