https://github.com/mheap/markdown-to-jira
Create Jira tickets from a plain text format
https://github.com/mheap/markdown-to-jira
cli jira markdown
Last synced: about 1 year ago
JSON representation
Create Jira tickets from a plain text format
- Host: GitHub
- URL: https://github.com/mheap/markdown-to-jira
- Owner: mheap
- Created: 2019-05-18T07:02:06.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-06-23T01:52:22.000Z (about 2 years ago)
- Last Synced: 2025-03-29T23:51:11.427Z (about 1 year ago)
- Topics: cli, jira, markdown
- Language: JavaScript
- Homepage:
- Size: 104 KB
- Stars: 13
- Watchers: 1
- Forks: 3
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Markdown to Jira
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. It does not currently
support epics.
## Installation
```bash
npm install -g markdown-to-jira
```
Create a file at `~/.atlassian/credentials` with the following contents:
```ini
[default]
host=your_company.atlassian.net
username=user@your-company.com
token=TOKEN # See https://id.atlassian.com/manage/api-tokens
project=ACME
```
## Usage
To 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
### Provide a string on the CLI
```
m2j -s 'This is an example ticket @michael.heap {Documentation} {Node} #label99'
```
### Provide a file
```
m2j -f /path/to/file
```
Example content:
```
- This is an example ticket @michael.heap {Documentation} {Node} #label99
```
## Ticket format
## Basic
* `@user.name` - assign a ticket and any child tickets to a user
* `{Name}` - add a component to a ticket. Supports multiple components
* `#label1` - add a label to a ticket. Supports multiple labels
* Any other text on the line will be used as the ticket title
### Advanced
If you're using the `-f` option to pass a filename there are additional options available.
```
- This is an example ticket @michael.heap {Documentation} {Node} #label99
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
- One more ticket, which will have children @michael.heap
This is a description
- And this is a sub-ticket
Subtickets can have descriptions too, and they inherit the assignee
and components from the parent ticket
```