Skip to end of metadata
Go to start of metadata

Jira Issue Importer script.

The jira importer script is used to convert google docs spreadsheets of tasks to be done into jira tickets. The scripts can be found athttps://github.com/ooici/JiraIssueImporter

Configuring a subsystems loader config.file

# Config File conventions.
'#' is a comment character, anything after it on the same line is ignored.
'[ ]' square brackets contain section designators.

  • [jira] section
    • url= specifies the url to the jira web services for the script to use.
    • username= specifies the jira login username to use by default. can be overridden from command line parameters.
    • password= use only if you are lazy and don't care if you accidentally upload your jira password into git... (ITS A TRAP!)
    • csv_file_name= this specifies the name of the csv file to be loaded.  Note that spaces do not need to be escaped.
    • reporter= specifies who the created issues should show as created by.
    • separator= specifies the delimiter used in the CSV file to separate columns.
    • quote_char= specifies the quote char used for columns that contain a separator character.
    • filter_column= specifies the title of the column used to filter different iterations from being imported.
    • filter_value= specifies the value to check for in a filter_column, if a match is found, the is imported.
  • [Projects] section
    • key=value where key is the human readable subsystem name in the csv, and value is the short jira name for the subsystem.
  • [priorities] section
    • This section is comprised of key=value where key is a term found in the CSV priority column, and value is a intermediary mapping.  see below.
  • [jira_priority] section
    • This section is comprised of key=value where key is the value term from the above intermediary mapping, and the value field is the numeric priority Jira uses.
  • [field_mappings] section
    • This is key value mappings between the column name used internal to the system, and the column number within the CSV. 
  • [used_mappings] section
    • This section specifies the names and col numbers of a subset of required columns.
      • Description
      • TaskTitle
      • Priority
      • TimeEstimate
      • Assignee
      • AffectsVersion - Can specify multiple comma separated versions.
      • Components - specifies the column that designates the component for the entry. note, this value stays set until a row in teh csv overwrites it.
  • [output_mappings] section
    • this section specifies which column should be over-written with the JiraKey in the output file showing successful entries.

Loading a subsystem's jira tasks from a CSV into Jira

As a result of the above command the following output files are created.

  • output.CEI.txt 
    • this file contains lots of useful debugging information to help you when things don't go perfect, which almost never happens.
  • reject-R2 COI Task List - R2C4-COI.csv
    • This file contains the rejected rows along with copies of the control rows, and is suitable for re-ingestion.  typically, the output file is scanned for the cause of the problem, then this file is corrected, and the config is edited to reflect the new CSV name, and it is re-ingested to load only the rows that were skipped last run.
  • results-R2 CEI Task List - R2C4-CEI.csv
    • This is a CSV file that is a copy of the original, containing rows that were successfully added, with a column updated to contain the jira key.  note, rejected rows will not be present.
  • R2 CEI Task List - R2C4-CEI.csv
    • This is the original CSV file specified in the config file.
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.