Versions Compared

Key

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

This script should be run with TFS4JIRA Self 9.7 or higher.

Tested with: Azure DevOps Services, Jira Cloud, and Jira DC 9.X

This is a Python script that updates the linked AzureDevOps work item ID in each Jira issue. This field is needed in order to properly synchronize Jira issues with ADO work items.

...

The organization migrated ADO work items from one instance to a different one, resulting in all migrated work items receiving new IDs. OutcomeThe outcome, Jira issues pointed to old work item IDs.

...

  1. Set the API endpoint URL

    1. ADO credentials

      1. org_url = '<https://dev.azure.com/<ORG>/'> - Azure DevOps (ADO) organization URL

      2. pat = 'xemhf6ez4i7svvho' - Personal access token (replace with your own token)

      3. project = 'xyz1234' - Project name in Azure DevOps (ADO)

      4. JiraFieldInADO = 'Custom.T4J_IssueKey' - Custom field in ADO used to store JIRA Issue Key

    2. JIRA credentials

      1. JiraUrl = 'http://52.24.97.338:8080' - Set JIRA URL

      2. auth = ('<username>', '<password>') - Set the authentication credentials - username and password

      3. ADOfieldInJira = 'customfield_10112' - Custom field in Jira used to store work Item ID

  2. OPTIONAL - the query used to fetch ADO work items can be modified to only fetch relevant work items (for example, with specific Area Path)

    Code Block
    languagesql
    wiql_query = f'SELECT [System.Id] FROM WorkItems WHERE [System.TeamProject] = "{project}" and [{JiraFieldInADO}] <>""'

WHAT WILL IT DO?

  1. Script The script will get the list of all the work item IDs and saved Jira keys from the new ADO instance.

  2. Having the list of IDs, script will connect to each Jira issue (using obtained key) and update ADOfieldInJira with new work item ID.

  3. Script will display error messages at any step in the PyCharm console, informing what went wrong

  4. Script will also save a log file with the following format (each run, one log file): workitem_update_script_log_<date>-<time>