This project is a command line tool to allow you to make markdown-like notes as
plain text and use them to create Jira tickets. It supports title, description,
assignee and components for both parent and sub-tasks.
npm install -g markdown-to-jiraCreate a file at ~/.atlassian/credentials with the following contents:
[default]
host=your_company.atlassian.net
username[email protected]
token=TOKEN # See https://id.atlassian.com/manage/api-tokens
project=ACMETo run the tool in dry-run mode and test your task definition, run the tool with
the -d flag. This will output ticket ID 9999 for any parent tasks and 1234
for any child tasks. No API requests will be sent and no tickets will be created
m2j -s 'This is an example ticket @michael.heap {Documentation} {Node}'
m2j -f /path/to/file
Example content:
- This is an example ticket @brandon.kelly {Documentation} {Node}
@user.name- assign a ticket and any child tickets to a user{Name}- add a component to a ticket. Supports multiple components+10- add 10 story points (as an example) to a ticket- Any other text on the line will be used as the ticket title
If you're using the -f option to pass a filename there are additional options available. Note that you can also
put global options in the Front Matter for the file (example provided below). This includes linking tickets to a
specific story and epic. To do so, simply provide that context at the top of the file.
---
epic: AS-12345
story: AS-12345
team: Cloud Integrations
classification: Development
---
- This is an example ticket @michael.heap {Documentation} {Node} +10
This is a description for the above title. It will be added
automatically and the description can span multiple lines
- This is another top level ticket without an assignee or components +4
- One more ticket, which will have children @michael.heap
This is a description
- And this is a sub-ticket +8
Subtickets can have descriptions too, and they inherit the assignee
and components from the parent ticket