cli

README

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.

Documentation

Overview

Package issues2markdown queries issues and renders the result to markdown following the Github flavored Markdown task lists format described at https://help.github.com/articles/about-task-lists/.

Index

• func ShowVersionInfo(version, build string) string

Functions

func ShowVersionInfo

func ShowVersionInfo(version, build string) string

ShowVersionInfo returns version and build information