todo

todo

Auto-generate issues through TODOs in code using your favorite issue tracking software and version control repository hosting service

Usage

To use todo in your projects, navigate to the todo app page and allow access to your repos (public/private).

For every push to GitHub, todo will scan your code and create new issues for your project. Example issues here.

Installation

$ go get github.com/while-loop/todo/cmd/...

Running

Command line

$ todod

Docker

$ docker run -d --name todo -v `pwd`:/todo -p 8675:8675 toyotasupra/todo todod -i /todo/config.yml

Example TODOs

Go:

func Doer() error {
    // TODO(while-loop) Create Doer in main +label1 +feature/Doer @user1
    panic("implement me")
}

Python:

def get_homepage(url):
    page = None
    try:
        page = urllib.request.urlopen(url).read()
    except Exception, e:
        # TODO(while-loop) Handle retries when retrieving homepage +api
        print e

    return page
}

Supported Services

Repository Hosting Service

• Github
• Gitlab (todo)

Issue Tracking

• Github
• Jira (todo)

Determining a Complete TODO

To automatically close issues, several methods of completion are implemented.

Issues are closed when:

• A commit into master referencing the issue ID
• A changelog entry referencing the issue ID

Changelog

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

CHANGELOG.md

License

todo is licensed under the Apache 2.0 License. See LICENSE for details.

Author

Anthony Alves