MichaelMure/git-bug
1
1
Fork 0
mirror of https://github.com/MichaelMure/git-bug.git synced 2024-12-14 17:51:44 +03:00
Code Issues Projects Releases Wiki Activity
Distributed, offline-first bug tracker embedded in git, with bridges
223 Commits 47 Branches 10 Tags 38 MiB
Go 93.4%
TypeScript 4.7%
Shell 1.7%
116a94401f
Go to file
Michael Muré 116a94401f
Merge pull request #32 from tplk/patch-1 
webui: add name to web app manifest
2018-08-28 19:05:17 +02:00
bug bug: add a new BugExerpt that hold a subset of a bug state for efficient sorting and retrieval 2018-08-23 19:19:16 +02:00
cache cache: maintain, write and load from disk bug excerpts 2018-08-23 21:24:57 +02:00
commands cache: lock the repo with a pid file; automatic cleaning 2018-08-21 19:13:08 +02:00
doc docs: fix some typos 2018-08-17 18:46:03 +01:00
graphql better naming for the graphql-s root resolver 2018-08-27 12:15:41 +02:00
input cleanup go imports 2018-08-13 18:39:19 +02:00
misc bug: introduce WithSnapshot to maintain incrementally and effitiently a snapshot 2018-08-23 19:15:50 +02:00
repository bug: remove use of the too recent %(refname:lstrip=-1) of git 2018-08-19 13:58:55 +02:00
termui cache: maintain, write and load from disk bug excerpts 2018-08-23 21:24:57 +02:00
tests bug: add a benchmark for reading all bugs in a repo 2018-08-19 21:27:10 +02:00
util cache: lock the repo with a pid file; automatic cleaning 2018-08-21 19:13:08 +02:00
vendor add a new main to generate random bugs 2018-08-16 18:22:00 +02:00
webui webui: add name to web app manifest. 2018-08-27 21:59:53 +03:00
.gitignore upgrade the readme 2018-08-06 03:26:42 +02:00
.travis.yml webui: Ensure code format in CI by running eslint 2018-08-19 23:14:45 +02:00
git-bug.go webui: pack the files only on demand 2018-08-06 16:17:11 +02:00
Gopkg.lock add a new main to generate random bugs 2018-08-16 18:22:00 +02:00
Gopkg.toml vendor gocui on the master branch because of no release in a while 2018-07-30 18:22:52 +02:00
LICENSE Create LICENSE 2018-07-12 12:54:04 +02:00
Makefile bug: add benchmarcks for bug merge 2018-08-19 20:40:50 +02:00
README.md readme: more styling 2018-08-21 14:46:36 +02:00

README.md

git-bug

Distributed bug tracker embedded in Git.

Build Status License: GPL v3 GoDoc Go Report Card Gitter chat

Would it be nice to not have to rely on a web service somewhere to deal with bugs ?

Would it be nice to be able to browse and edit bug reports offline?

git-bug is a distributed bug tracker embedded in git. It uses git's internal storage so no files are added in your project.

As you would do with commits and branches, you can push your bugs to the same git remote you are already using to collaborate with other people.

🚧 This is for now a proof of concept. Expect dragons and unfinished business. 🚧

Install

Go get

go get github.com/MichaelMure/git-bug

If it's not done already, add golang binary directory in your PATH:

export PATH=$PATH:$GOROOT/bin:$GOPATH/bin

Pre-compiled binaries

  1. Go to the release page and download the appropriate binary for your system.
  2. Copy the binary anywhere in your PATH
  3. Rename the binary to git-bug (or git-bug.exe on windows)

That's all !

Linux packages

CLI usage

Create a new bug:

git bug new

Your favorite editor will open to write a title and a message.

You can push your new entry to a remote:

git bug push [<remote>]

And pull for updates:

git bug pull [<remote>]

List existing bugs:

git bug ls

You can now use commands like show, comment, open or close to display and modify bugs. For more details about each command, you can run git bug <command> --help or read the command's documentation.

Interactive terminal UI

An interactive terminal UI is available using the command git bug termui to browse and edit bugs.

Web UI (status: WIP)

You can launch a rich Web UI with git bug webui.

Web UI screenshot 1 Web UI screenshot 2

This web UI is entirely packed inside the same go binary and serve static content through a localhost http server.

The web UI interact with the backend through a GraphQL API. The schema is available here.

Internals

Interested by how it works ? Have a look at the data model.

Misc

Planned features

  • media embedding
  • import/export of github issue
  • extendable data model to support arbitrary bug tracker
  • inflatable raptor

Contribute

PRs accepted. Drop by the Gitter lobby for a chat.

License

GPLv3 or later © Michael Muré