Derby
  1. Derby
  2. DERBY-5080

Utilize JQL to fetch JIRA issue list for release notes generation

    Details

    • Type: Improvement Improvement
    • Status: Closed
    • Priority: Minor Minor
    • Resolution: Fixed
    • Affects Version/s: 10.8.1.2
    • Fix Version/s: 10.9.1.0
    • Component/s: Build tools
    • Labels:
      None

      Description

      DERBY-4857 made it possible to use the JIRA SOAP API to fetch a list of issues fixed in a release. However, the release manager have to manually create a JIRA filter and feed the filter id to the tool.
      Now that the Apache JIRA instance has been updated to 4.x, we can use the JIRA Query Language (JQL) to avoid that manual step.

      1. derby-5080-2a-utilize_jql.stat
        0.3 kB
        Kristian Waagan
      2. derby-5080-2a-utilize_jql.diff
        9 kB
        Kristian Waagan
      3. derby-5080-3a-report_disqualifications_knob.diff
        2 kB
        Kristian Waagan

        Issue Links

          Activity

          Hide
          Kristian Waagan added a comment -

          I updated the SOAP API service description to match JIRA 4.2 with revision 1076016.

          Show
          Kristian Waagan added a comment - I updated the SOAP API service description to match JIRA 4.2 with revision 1076016.
          Hide
          Kristian Waagan added a comment -

          Attaching patch 2a, which makes the SOAP client use JQL to obtain the list of issues to include in the release notes.

          The addition is backward compatible, that is you can continue to use manually created JIRA filters without any changes. The only thing required to make the tool use JQL is to specify a JIRA filter id of 0 (zero) when invoking the ant script (i.e. ant -Doption=X genrelnotes in tools/release). You can also use the SOAP client directly, but that's slightly more tedious. I'll see if I can add a README.

          Patch ready for review.

          Show
          Kristian Waagan added a comment - Attaching patch 2a, which makes the SOAP client use JQL to obtain the list of issues to include in the release notes. The addition is backward compatible, that is you can continue to use manually created JIRA filters without any changes. The only thing required to make the tool use JQL is to specify a JIRA filter id of 0 (zero) when invoking the ant script (i.e. ant -Doption=X genrelnotes in tools/release). You can also use the SOAP client directly, but that's slightly more tedious. I'll see if I can add a README. Patch ready for review.
          Hide
          Rick Hillegas added a comment -

          Thanks, Kristian. The patch looks good to me. I have applied it and successfully generated release notes using a filter id of 0.

          Show
          Rick Hillegas added a comment - Thanks, Kristian. The patch looks good to me. I have applied it and successfully generated release notes using a filter id of 0.
          Hide
          Kristian Waagan added a comment -

          Thanks, Rick.

          Committed patch 2a to trunk with revision 1129117.

          I did generate the 10.8 release notes and compared them to what is checked in on the 10.8 branch. Besides from some unrelated formatting differences, the tool now adds a few additional issues because their JIRA status changed (i.e. marked as resolved after the 10.8 release notes were generated), and there was one issue that didn't make it (I assume the issue for the istat feature, DERBY-3788, was added manually?).

          I hope I have addressed the issue where there are several release candidates, and I have also made the tool exclude higher versions with the same fix-pack as the release (that is, don't include 10.8.1.3 when generating release notes for 10.8.1.2).

          Running the tool with release version 10.8.1.3 results in the delta between 10.8.1.3 and 10.8.1.2 (19 issues at time of writing). This requires that you change the value of previousRelease in releaseSummary.xml.

          Show
          Kristian Waagan added a comment - Thanks, Rick. Committed patch 2a to trunk with revision 1129117. I did generate the 10.8 release notes and compared them to what is checked in on the 10.8 branch. Besides from some unrelated formatting differences, the tool now adds a few additional issues because their JIRA status changed (i.e. marked as resolved after the 10.8 release notes were generated), and there was one issue that didn't make it (I assume the issue for the istat feature, DERBY-3788 , was added manually?). I hope I have addressed the issue where there are several release candidates, and I have also made the tool exclude higher versions with the same fix-pack as the release (that is, don't include 10.8.1.3 when generating release notes for 10.8.1.2). Running the tool with release version 10.8.1.3 results in the delta between 10.8.1.3 and 10.8.1.2 (19 issues at time of writing). This requires that you change the value of previousRelease in releaseSummary.xml.
          Hide
          Kristian Waagan added a comment -

          Attaching patch 3a, which makes it possible to specify -DreportDisqualifications=true when running ant genrelnotes to make the JIRA SOAP client report issues that are disqualified because they have already been included in a release ancestor. To be used primarily for debugging, and by the curious

          Committed to trunk with revision 1129132.

          Show
          Kristian Waagan added a comment - Attaching patch 3a, which makes it possible to specify -DreportDisqualifications=true when running ant genrelnotes to make the JIRA SOAP client report issues that are disqualified because they have already been included in a release ancestor. To be used primarily for debugging, and by the curious Committed to trunk with revision 1129132.
          Hide
          Kristian Waagan added a comment -

          Resolving issue.

          I'm not sure if we should add a JIRA to verify that this functionality works, or if seeing the JQL and the resulting release notes (which is reviewed by the community) is enough...

          Show
          Kristian Waagan added a comment - Resolving issue. I'm not sure if we should add a JIRA to verify that this functionality works, or if seeing the JQL and the resulting release notes (which is reviewed by the community) is enough...
          Hide
          Kristian Waagan added a comment -

          Closing issue.

          Show
          Kristian Waagan added a comment - Closing issue.

            People

            • Assignee:
              Kristian Waagan
              Reporter:
              Kristian Waagan
            • Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Development