Skip to content

Latest commit

 

History

History
107 lines (82 loc) · 3.33 KB

README.md

File metadata and controls

107 lines (82 loc) · 3.33 KB
Raw

README

Gitrack is a distributed issue/bug/note/whatever tracker for git (and possibly others) written in POSIX shell and inspired by BugsEverywhere. Gitracker is different from BugsEverywhere in that it tries to be a generic interface for tracking .. well .. anything (not just bugs) and aims to support file attachments, threaded comment history, and customizable workflow. All while being written in POSIX shell script.

Benefits

  • Bugs/Notes/Issues live with their respective code. When you merge a bugfix branch that uses Gitrack, you merge the tracker history along with the coded bugfix.

  • Full off-line access to your bugs, notes, issues as well as being able to comment on other users notes in a forum-style development process.

  • Automatic generation of a markdown web view of the tracker database during git push so that all entries are browsable from GitHub/GitLab (modifying issues from the webinterface would require specialized software on the server-side).

Warning

This code is very young (less than 20 commits at the time of this writing). The work is still in flux and many features are not yet complete and the tracker database format may or may not change.

Installation

Simply copy git-track to a directory in your PATH. From there you can use the tracker as a git sub-command.

Example:

$ git track help commands
git-track commands:
  config               Modify the tracker config
  list                 List existing tracks and track types
  new                  Create a new track
  update               Update/Modify an existing track
  show                 Display the specified track
  close                Close an existing track (wrapper to update)
  reopen               Reopen a closed track (wrapper to update)
  comment              Comment on an existing track

Report bugs to http://github.com/major0/gitrack

Getting Started

To create your first track simply pick a topic, such as bug, issue, note, whatever you want to open the track under:

$ git track new headache -m 'An example track' -m 'This line will end up in the body.' -m 'As will this one'
[master 241fead] New headache(538fe22): An example track
 4 files changed, 13 insertions(+)
 create mode 100644 .gitrack/headache/538fe22aeb4ce625453c28cbae8486903afb482b/head
 create mode 100644 .gitrack/headache/538fe22aeb4ce625453c28cbae8486903afb482b/refs/538fe22aeb4ce625453c28cbae8486903afb482b
 create mode 100644 .gitrack/headache/538fe22aeb4ce625453c28cbae8486903afb482b/state
 create mode 100644 .gitrack/headache/538fe22aeb4ce625453c28cbae8486903afb482b/status
$

To list existing types of tracks invoke the list command:

$ git track list
Types: headache
$

Or specify a type to list tracked entries:

$ git track list headache
headache/538fe22:   open:new        unassigned  An example track
$

An you can examine the specific track:

$ git track show headache/538fe22
Entry: headache/538fe22aeb4ce625453c28cbae8486903afb482b
State: open
Status: new
Owner: unassigned
Summary: An example track

This line will end up in the body.

As will this one

Checkout `git track help <command>` for help on a specific command.
$

License

Like git, this project is licensed under the GPLv2 (not GPLv2.2, GPLv3, etc). For more information see the COPYING file.

Author

Mark Ferrell