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.
USE CASE
The organization migrated ADO work items from one instance to a different one, resulting in all migrated work items receiving new IDs. Outcome, Jira issues pointed to old work item IDs.
PREREQUISITES:
TFS4JIRA Self-Hosted 9.7 or higher
The latest version of Python: https://www.python.org/downloads/
Python IDE: PyCharm: https://www.jetbrains.com/pycharm/download/ (we will run the script in this editor)
The script:
INITIAL SETUP IN SCRIPT :
Set the API endpoint URL
ADO credentials
org_url = '<https://dev.azure.com/<ORG>/'> - Azure DevOps (ADO) organization URL
pat = 'xemhf6ez4i7svvho' - Personal access token (replace with your own token)
project = 'xyz1234' - Project name in Azure DevOps (ADO)
JiraFieldInADO = 'Custom.T4J_IssueKey' - Custom field in ADO used to store JIRA Issue Key
JIRA credentials
JiraUrl = 'http://52.24.97.338:8080' - Set JIRA URL
auth = ('<username>', '<password>') - Set the authentication credentials - username and password
ADOfieldInJira = 'customfield_10112' - Custom field in Jira used to store work Item ID
OPTIONAL - the query used to fetch ADO work items can be modified to only fetch relevant work items (for example with specific Area Path)
wiql_query = f'SELECT [System.Id] FROM WorkItems WHERE [System.TeamProject] = "{project}" and [{JiraFieldInADO}] <>""'
WHAT WILL IT DO?
Script will get the list of all the work item IDs and saved Jira keys from new ADO instance
Having the list of IDs, script will connect to each Jira issue (using obtained key) and update ADOfieldInJira with new work item ID.
Script will display error messages at any step in the PyCharm console, informing what went wrong
Script will also save a log file with following format (each run, one log file): workitem_update_script_log_<date>-<time>