jira-issue-generator

Generate CSV files for importing issues into Jira from markdown files.

Usage

1. Create a Markdown file.

2. Create a YAML frontmatter section to specify global metadata

   1. At the top of the file, add a snipped of YAML surrounded by horizontal rules.

      ---
      parent: 'PAC-21694'
      ---
      
      # Your 1st issue

      Check out the Frontmatter type for a list of expected keys.

3. Specify your Jira issues within it using Markdown syntax

   • A leading level-1 heading (# like this) specifies the issue summary

   • Optionally add a table underneath to add metadata about the issue

     | Key      | Value |
     | -------- | ----- |
     | Type     | story |
     | Priority | 4     |

     • The table must start with the header row "|Key|Value|"
     • Check the IssueMetadata type for supported metadata

   • Add your (simple) Markdown-formatted description

   • To create a 2nd issue, separate it from your 1st issue with a horizontal rule (eg: ---)

   [!TIP] Check out the sample issue file below for a full example.

4. Run npx jira-issue-generator YOUR_MARKDOWN_FILE.md to generate your CSV & JSON files for importing in to Jira.

5. Open the Jira importer

   1. Go to Jira
   2. Select "Filters" in the top nav bar
   3. Click "View all issues"
   4. Click the overflow ("•••") in the top right
   5. Click "Import issues from CSV"

   or

   https://paciolan.atlassian.net/secure/BulkCreateSetupPage!default.jspa?externalSystem=com.atlassian.jira.plugins.jim-plugin%3AbulkCreateCsv&new=true

6. Add the generated CSV to "CSV Source File"

7. Check "Use an existing configuration file"

8. Select the generate JSON configuration

9. Hit "Next" until you're done!

Sample issue file

---
parent: 'PAC-21694'
project-name: 'Integrations'
project-key: 'INT'
dev-team-name: 'Integrations'
dev-team-field-id: 10055
---

# Hello world

| Key      | Value |
| -------- | ----- |
| Type     | story |
| Priority | 3     |

Some simple **markdown** to describe the issue.

---

# A 2nd issue

| Key      | Value |
| -------- | ----- |
| Type     | bug   |
| Priority | 1     |

Write a nice descriptive body