issues2markdown / cli

issues2markdown CLI tool

issues2markdown

Convert a list of issues to markdown.

Installation

Once you have installed Go, run these commands to install issues2markdown tool:

go get github.com/issues2markdown/cli

Documentation

Execute the following command to get the provided command line tool usage information:

$ issues2markdown --help
issues2markdown converts a list of github issues to markdown list format

Usage:
  issues2markdown [flags]

Flags:
      --github-token string   github token
  -h, --help                  help for issues2markdown
  -v, --verbose               enable verbose mode
      --version               version for issues2markdown

Example output

An example of the output could be:

- [ ] org/repo : [Issue Title 1](https://github.com/org/repo/issues/1)
- [x] org/repo : [Issue Title 2](https://github.com/org/repo/issues/2)
- [x] org/repo : [Issue Title 3](https://github.com/org/repo/issues/3)
- [ ] org/repo2 : [Issue Title 1](https://github.com/org/repo2/issues/1)

Which will render as:

• org/repo : Issue Title 1
• org/repo : Issue Title 2
• org/repo : Issue Title 3
• org/repo2 : Issue Title 1

License

Copyright (c) 2018 issues2markdown Authors.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

cli's Issues

Trim the last breakline from the rendered ouput result

Description

Currently the result is something like this:

- line 1<breakline>
- line 2<breakline>
<breakline>

The last <breakline> must be trimmed out from the output.

Render data as markdown list

Description

Render output as markdown list.

Support for state parameter

Description

Support for state parameter (https://developer.github.com/v3/issues/#parameters)

Add verbose mode

Description

Add verbose flag to show verbose debug execution information to the CLI tool.

• By default verbose mode is false or off
• Support for --verbose long option
• Support for -v short optiob

Add support for appveyor CI (windows)

Description

Add support for appveyor CI (windows)

Add support for --github-token flag

Description

Add support for --github-token flag

Add support for goreleaser

Description

Add support for goreleaser

Support ordering direction

Description

Add support for flag --order-direction

• QueryOptions must have support for sorting direction property.
• Field name could be SortDirection or OrderDirection or Order.
• Possible values are: "asc", "desc"
• Default value is "desc"

Add .github folder with templates

defaultQuery should be provided by QueryOptions

Description

defaultQuery should be provided by QueryOptions

Use cobra to handle cli arguments and flags

Description

Use cobra to handle cli arguments and flags but don't implement any of them yet.

github_token should be on QueryOptions

Description

github_token should be on QueryOptions

Implement -version flag

Description

Implement -version flag.
Shoud report the current version number and also the build.

Default query

Description

• Default query is https://developer.github.com/v3/issues/#list-issues

show state on render

Description

• Snow state of the issue on render

Support for --templateFile to customize the output

Description

Support for --templateFile to customize the output

• Template file must be the entire template source not only the template of one item

Search issues on github

Description

Search github issues on github to fetch the data to render.

Add Coveralls

Support for organization and repository flags

Description

Support organization and repository flags (https://developer.github.com/v3/issues/#parameters)

Support for --format to customize the output by hand

Description

Support for --format to customize the output by hand

• Format flag is a template source for the entire output

Create common files and dev environment skeleton

Makefile
main.go
etc ...

Create a QueryOptions type to allow query customization

Description

Create a QueryOptions type to allow query customization

Also create a default optioons

Add CircleCI

defaultTemplate should be on RenderOptions

Description

defaultTemplate should be on RenderOptions

Do not hardcode github key

Description

Currently the token key to use the github api is hardcoded. Provide this information using:

• A flag
• An environment variable
• Configuration file
• ...

All calls to github api should be authorized with Github OAuth

Description

All calls to github api should be authorized with Github OAuth

Implement pagination on query issues (get all issues)

Description

Implement pagination on query issues (get all issues and not only the first page).

Support ordering

Description

Add support for flag --order-by

• QueryOptions must have support for sorting property.
• Field name could be Sort or Order.
• Possible values are: "", "comments", "created", "updated"
• Default value is "" which means best match

Create a RenderOptions type to allow rendering customization

Description

Create a RenderOptions type to allow rendering customization

Also provide default options