:ticket: mkissue

Create GitHub issues from importing CSV file.

:arrow_forward: Usage

Create GitHub issues

You need to create personal access token for GitHub (scope:repo) before mkissue runs.

# Install tool
$ npm install -g mkissue

# Create GitHub issues
$ mkissue run issues.csv
Loaded issue data from csv file:

  Title                                                             Labels
  Enable to install from npm registry                               feature request
  Save GitHub token for creating issues to local configuration file feature request
  Add ZenHub support                                                feature request, discussion
  Add CI/CD for using GitHub Actions                                feature request

  What is owner name?: kentaro-m
  What is repository name?: create-issues-test
  What is GitHub host?: https://api.github.com
  What is GitHub token?: ****************
  What is ZenHub host?: https://api.zenhub.io
  What is ZenHub token?: ****************
  Continue? [yes/no]: yes
  Creating issues... done

Create CSV file contain issue data

The header of CSV file contains need to title, body, and labels. Please refer to the template below.

mkissue template (Google Sheets)

title,body,labels,milestone,estimate,epic-url
titleA,bodyA,"good first issue,bug",SPRINT001,2,https://github.com/owner/repo/issue/1
titleB,bodyB,bug,SPRINT001,5,https://github.com/owner/repo/issue/1
titleC,bodyC,enhancement,SPRINT001,13,https://github.com/owner/repo/issue/2

Milestone, estimate and epic-url are optional. If you want to set estimate or epic-url, you must set ZenHub token.

:video_game: Commands

• mkissue help [COMMAND]
• mkissue run FILE

mkissue help [COMMAND]

display help for mkissue

USAGE
  $ mkissue help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

mkissue run FILE

create issues from csv file

USAGE
  $ mkissue run FILE

ARGUMENTS
  FILE  where to load csv file

OPTIONS
  -h, --help  show CLI help
  --zenhub

EXAMPLES
  $ mkissue run issues.csv
  Loaded issue data from csv file:

  Title                                                             Label
  Enable to install from npm registry                               feature request
  Save GitHub token for creating issues to local configuration file feature request
  Add ZenHub support                                                feature request, discussion
  Add CI/CD for using GitHub Actions                                feature request

  What is owner name?: kentaro-m
  What is repository name?: create-issues-test
  What is GitHub host?: https://api.github.com
  What is GitHub token?: ****************
  What is ZenHub host?: https://api.zenhub.io
  What is ZenHub token?: ****************
  Continue? [yes/no]: yes
  Creating issues... done

See code: src/commands/run.ts

:construction_worker: Development

# install dependencies
$ npm install

# execute the command
$ ./bin/run run issues.csv

:memo: LICENSE

MIT