Distributed, offline-first bug tracker embedded in git, with bridges
Go to file
Josh Bialkowski be763b4c4c update README
2020-02-19 09:39:02 -08:00
.github Update FUNDING.yml 2019-05-23 19:04:11 +02:00
bridge metaKeyJiraOperationId -> metaKeyJiraDerivedId 2020-02-17 13:37:57 -08:00
bug Merge remote-tracking branch 'origin/master' into cheshirekow-jira 2020-02-09 20:23:38 +01:00
cache Merge remote-tracking branch 'origin/master' into cheshirekow-jira 2020-02-14 22:56:59 +01:00
commands bridges: massive refactor 2020-02-15 02:55:19 +01:00
doc Merge remote-tracking branch 'origin/master' into cheshirekow-jira 2020-02-15 03:07:45 +01:00
entity bridge: huge refactor to accept multiple kind of credentials 2019-12-08 21:28:27 +01:00
graphql graphql: server side take responsability to commit 2020-02-12 22:02:11 +01:00
identity bridges: pass the context to Init for when a client build process needs it 2020-02-15 15:46:36 +01:00
input bridges: more refactor and cleanup 2020-02-15 13:45:14 +01:00
misc bridges: massive refactor 2020-02-15 02:55:19 +01:00
repository * Fix git config reader can't read values with spaces 2020-01-04 13:04:15 +01:00
termui various cleanups suggested by golang-ci 2020-02-08 16:17:15 +01:00
tests repo: refactor how test repo are created/cleaned 2019-05-27 21:14:55 +02:00
util switch to go-term-text to fix bad underflow for label rendering 2019-11-03 14:00:35 +01:00
webui webui: format some files 2020-02-12 23:39:23 +01:00
.gitignore gitignore: ignore jetbrains project files 2018-12-05 19:43:20 +01:00
.travis.yml travis: test with latest nodejs and LTS 2020-02-12 23:48:46 +01:00
git-bug.go build: drop support for go 1.10 2020-02-06 13:14:29 +01:00
go.mod Merge pull request #319 from MichaelMure/dependabot/go_modules/github.com/xanzy/go-gitlab-0.25.0 2020-02-13 00:31:26 +01:00
go.sum Merge pull request #319 from MichaelMure/dependabot/go_modules/github.com/xanzy/go-gitlab-0.25.0 2020-02-13 00:31:26 +01:00
LICENSE Create LICENSE 2018-07-12 12:54:04 +02:00
Makefile fix version not set properly when built on travis 2020-01-22 14:14:24 +01:00
README.md update README 2020-02-19 09:39:02 -08:00

git-bug

Build Status Backers on Open Collective Sponsors on Open Collective License: GPL v3 GoDoc Go Report Card Gitter chat

git-bug is a bug tracker that:

  • is fully embeded in git: you only need your git repository to have a bug tracker
  • is distributed: use your normal git remote to collaborate, push and pull your bugs!
  • works offline: in a plane or under the sea? Keep reading and writing bugs!
  • prevents vendor lock-in: your usual service is down or went bad? You already have a full backup.
  • is fast: listing bugs or opening them is a matter of milliseconds
  • doesn't pollute your project: no files are added in your project
  • integrates with your tooling: use the UI you like (CLI, terminal, web) or integrate with your existing tools through the CLI or the GraphQL API
  • bridges to other bug trackers: use bridges to import and export to other trackers.

🚧 This is now more than a proof of concept, but still not fully stable. Expect dragons and unfinished business. 🚧

Install

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
go install (unstable)
go install github.com/MichaelMure/git-bug

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

export PATH=$PATH:$(go env GOROOT)/bin:$(go env GOPATH)/bin

CLI usage

Create a new identity:

git bug user create

Create a new bug:

git bug add

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

Filter and sort bugs using a query:

git bug ls "status:open sort:edit"

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.

Termui recording

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.

Bridges

Importer implementations

Github Gitlab Launchpad Jira
incremental
(can import more than once)
✔️ ✔️ ✔️
with resume
(download only new data)
✔️ ✔️ ✔️
identities ✔️ ✔️ ✔️ ✔️
identities update ✔️
bug ✔️ ✔️ ✔️ ✔️
comments ✔️ ✔️ ✔️ ✔️
comment editions ✔️ ✔️
labels ✔️ ✔️ ✔️
status ✔️ ✔️ ✔️
title edition ✔️ ✔️ ✔️
media/files  
automated test suite ✔️ ✔️

Exporter implementations

Github Gitlab Launchpad Jira
bug  ✔️ ✔️ ✔️
comments ✔️ ✔️ ✔️
comment editions ✔️ ✔️ ✔️
labels ✔️  ✔️ ✔️
status ✔️ ✔️ ✔️
title edition ✔️ ✔️ ✔️
automated test suite ✔️ ✔️  

Bridge usage

Interactively configure a new github bridge:

git bug bridge configure

Or manually:

git bug bridge configure \
    --name=mybridge \
    --target=github \
    --url=https://github.com/michaelmure/git-bug \
    --token=$TOKEN

Import bugs:

git bug bridge pull [<name>]

Export modifications:

git bug bridge push [<name>]

Deleting a bridge:

git bug bridge rm [<name>]

Internals

Interested by how it works ? Have a look at the data model and the internal bird-view.

Misc

Planned features

  • media embedding
  • more bridges
  • extendable data model to support arbitrary bug tracker
  • inflatable raptor

Contribute

PRs accepted. Drop by the Gitter lobby for a chat or browse the issues to see what is worked on or discussed.

Developers unfamiliar with Go may try to clone the repository using "git clone". Instead, one should use:

go get -u github.com/MichaelMure/git-bug

The git repository will then be available:

# Note that $GOPATH defaults to $HOME/go
$ cd $GOPATH/src/github.com/MichaelMure/git-bug/

You can now run make to build the project, or make install to install the binary in $GOPATH/bin/.

To work on the web UI, have a look at the dedicated Readme.

Contributors ❤️

This project exists thanks to all the people who contribute.

Backers

Thank you to all our backers! 🙏 [Become a backer]

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]

License

Unless otherwise stated, this project is released under the GPLv3 or later license © Michael Muré.

The git-bug logo by Viktor Teplov is released under the Creative Commons Attribution 4.0 International (CC BY 4.0) license © Viktor Teplov.