Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

...

  1. Name of the section. A section with the same name will be added to the release notes.
  2. Section description. If the text is specified - it will be added as a plain text after the section name.
  3. JQL variables. In order to build flexible JQL which will use data from the selected version or release the user can inject variables to JQL query. List of available variables depends on the template type
    1. Version specific variables
      1. Version name
      2. Start date
      3. Release date
      4. Projected release date
      5. Project key
      6. User name
      7. Current date
      8. Current timestamp
    2. Release specific variables
      1. Start date
      2. Release date
      3. Projected release date
      4. Versions in release
      5. User name
      6. Current date
      7. Current timestamp
  4. JQL query to extract an issue list. 
  5. If the option is enabled the section will be rendered if JQL will return 0 rows. Otherwise, the section will not be rendered at all.
  6. If this option is enabled all the issue will be grouped by respected Jira Epics.

    Info
    titleRelease template type

    For Release templates you can choose an option whether to group by Epic or Version


  7. The message which will be injected to a template if JQL will return 0 rows. This option will be working in case a switcher #5 is turned on.
  8. Columns to be shown in the table. User can select the majority standard and custom Jira fields. See details in the chapter below.

    Info
    title

...

  1. Hint

    In order to extract all issues in version use JQL:  fixVersion={version.name}

    For all issues in the release: fixVersion IN ({release.versions}) 


Columns configuration

On the "Columns" tab the user can define a list of columns to be presented the table.

...

You can use it to Copy/Paste into MS Word, Google Docs, Confluence and any other wiki with (almost) no changes to layout. See other options below plus Upcoming Features for more formats we plan to support shortly.

Upload to Confluence

...

To substitute “Copy/Paste to Confluence” we implemented a direct integration with Confluence to upload into one of your available spaces.

...

Info

"Access to fetch at ‘https://confluence.your_company_domain.com/rest/api/content’ from origin ‘http://jira.your_company_domain.com’ has been blocked"

or 

"Network error or CORS is not configured on your Confluence instance"

... it's because Cross-Origin Resource Sharing (CORS) is not enabled for your Confluence Server as result the requests which are coming from Jira are not accepted.

To overcome please follow the instructions below

  1. Stop Confluence server
  2. Navigate to your confluence home directory (Usually for Linux:  /opt/atlassian/confluence/)
  3. Open confluence_home_directory/confluence/WEB-INF/
  4. Backup web.xml
  5. Open web.xml for editing
  6. Add the flowing code block after the last <filter>...</filter>.

    Info

    Please replace  "https://jira.your_company_domain.com" to your confluence URL.


    Code Block
    linenumberstrue
    <filter>
      <filter-name>CorsFilter</filter-name>
      <filter-class >org.apache.catalina.filters.CorsFilter</filter-class >
      <init-param>
        <param-name>cors.allowed.origins</param-name>
        <param-value>https://jira.your_company_domain.com</param-value>
      </init-param>
      <init-param>
        <param-name>cors.allowed.methods</param-name>
        <param-value>OPTIONS,GET,POST,PUT,DELETE</param-value>
      </init-param>
      <init-param>
        <param-name>cors.exposed.headers</param-name>
        <param-value>Access-Control-Allow-Origin,Access-Control-Allow-Credentials</param-value>
      </init-param>
    
    <init-param>
        <param-name>cors.allowed.headers</param-name>
        <param-value>X-Atlassian-Token,Authorization, Content-Type,X-Requested-With,accept,Origin,Access-Control-Request-Method,Access-Control-Request-Headers</param-value>
      </init-param>
    
      <init-param>
        <param-name>cors.support.credentials</param-name>
        <param-value>true</param-value>
      </init-param>
    </filter>
    <filter-mapping>
      <filter-name>CorsFilter</filter-name>
      <url-pattern>/*</url-pattern>
    </filter-mapping>
    
    


  7. Save changes
  8. Start Confluence server and make sure that the server has been successfully started. If no, restore web.xml from backup

...