Versions Compared

Key

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

...

  1. TFS4JIRA Self-Hosted 9.7 or higher

  2. The latest version of Python: https://www.python.org/downloads/

  3. Python IDE: PyCharm: https://www.jetbrains.com/pycharm/download/ (we will run the script in this editor)

  4. The script:

View file
nameamend_wi_id_in_jira_issue.py

...

INITIAL SETUP IN SCRIPT :

  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 A 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 A 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}] <>""'

...

  1. 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, the script will connect to each Jira issue (using the obtained key) and update ADOfieldInJira with a new work item ID.

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

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

    Image RemovedImage Added

    1. The log file is saved in the same location as the script file and is immediately visible in PyCharm’s project files explorer