How to use the Jira-Finalizer in a qg-config

Prerequisites

First, you need to define a mapping between Jira issues and the qg-requirements. This is described here: How to map issues and requirements

Using the finalizer

In order to use the finalizer in your qg configuration, make sure to:

1. Add the jira-finalizer update-issues command to the run script in the finalize section of your qg-config.yaml file.

2. Add the mandatory environment variables: usually:

   • JIRA_USERNAME,

   • JIRA_PASSWORD and

   • JIRA_API_URL.

Below is an except of a qg-config.yaml file which shows the finalize section. If you don’t have a finalize section, just add it using the following code:

Excerpt of the finalize section of a qg-config.yaml file

finalize:
  run: |
    jira-finalizer update-issues
  env:
    JIRA_USERNAME: ${{ secrets.JIRA_USERNAME }}
    JIRA_PASSWORD: ${{ secrets.JIRA_PASSWORD }}

Note

While the Jira username can also be entered als clear text, make sure to always use secrets for sensitive information in qg-config files: see Using secrets.