git-bug

command module
Version: v0.7.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 21, 2021 License: GPL-3.0 Imports: 1 Imported by: 0

README ΒΆ

git-bug

Build Status Backers on Open Collective Sponsors on Open Collective 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. 🚧

Installation

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
Compile from git (unstable)
git clone git@github.com:MichaelMure/git-bug.git
make install

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 Jira Launchpad
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 Jira Launchpad
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=<bridge> \
    --target=github \
    --url=https://github.com/MichaelMure/git-bug \
    --login=<login>
    --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.

git clone git@github.com:MichaelMure/git-bug.git

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.

Documentation ΒΆ

The Go Gopher

There is no documentation for this package.

Source Files ΒΆ

Directories ΒΆ

Path Synopsis
Package bridge contains the high-level public functions to use and manage bridges
Package bridge contains the high-level public functions to use and manage bridges
core
Package core contains the target-agnostic code to define and run a bridge
Package core contains the target-agnostic code to define and run a bridge
github
Package github contains the Github bridge implementation
Package github contains the Github bridge implementation
jira
Package jira contains the Jira bridge implementation
Package jira contains the Jira bridge implementation
launchpad
Package launchpad contains the Launchpad bridge implementation
Package launchpad contains the Launchpad bridge implementation
Package bug contains the bug data model and low-level related functions
Package bug contains the bug data model and low-level related functions
Package cache contains a caching layer on top of the low-level bug and identity functions to provide efficient querying, filtering, sorting.
Package cache contains a caching layer on top of the low-level bug and identity functions to provide efficient querying, filtering, sorting.
Package commands contains the CLI commands
Package commands contains the CLI commands
Package entity contains the base common code to define an entity stored in a chain of git objects, supporting actions like Push, Pull and Merge.
Package entity contains the base common code to define an entity stored in a chain of git objects, supporting actions like Push, Pull and Merge.
Package graphql contains the root GraphQL http handler
Package graphql contains the root GraphQL http handler
connections
Package connections implement a generic GraphQL relay connection
Package connections implement a generic GraphQL relay connection
models
Package models contains the various GraphQL data models
Package models contains the various GraphQL data models
resolvers
Package resolvers contains the various GraphQL resolvers
Package resolvers contains the various GraphQL resolvers
Package identity contains the identity data model and low-level related functions
Package identity contains the identity data model and low-level related functions
Package input contains helpers to use a text editor as an input for various field of a bug
Package input contains helpers to use a text editor as an input for various field of a bug
misc
Package repository contains helper methods for working with the Git repo.
Package repository contains helper methods for working with the Git repo.
Package termui contains the interactive terminal UI
Package termui contains the interactive terminal UI
util
git

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL