Coder Social home page Coder Social logo

ukabu / git-bug Goto Github PK

View Code? Open in Web Editor NEW

This project forked from michaelmure/git-bug

0.0 1.0 0.0 17.26 MB

Distributed, offline-first bug tracker embedded in git, with bridges

License: GNU General Public License v3.0

Go 90.64% Makefile 0.25% HTML 0.06% JavaScript 0.12% Shell 3.32% TypeScript 5.61%

git-bug's Introduction

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. ๐Ÿšง

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 [email protected]: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

Workflows

There is multiple ways to use git-bug:

Native workflow

Native workflow

This is the pure git-bug experience. In a similar fashion as with code, use git bug push and git bug pull to push and pull your bugs between git remotes and collaborate with your teammate.

Bridge workflow

Bridge workflow

As git-bug has bridges with other bug-trackers, you can use it as your personal local remote interface. Sync with git bug bridge pull and git bug bridge push, work from your terminal, integrate into your editor, it's up to you. And it works offline !

Web UI workflow (WIP)

Web UI workflow

Often, projects needs to have their bug-tracker public and accept editions from anyone facing a problem. To support this workflow, git-bug aims to have the web UI accept external OAuth authentication and act as a public portal. However the web UI is not up to speed for that yet. Contribution are very much welcome!

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 [email protected]: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.

git-bug's People

Contributors

a-hilaly avatar adamslc avatar auyer avatar cheshirekow avatar deadbaed avatar dependabot-preview[bot] avatar dependabot-support avatar dependabot[bot] avatar hoijui avatar j-f1 avatar jfacchini avatar ludovicm67 avatar michaelmure avatar monkeywithacupcake avatar programfan avatar rafasc avatar sandhose avatar seeduvax avatar simonrw avatar steap avatar tplk avatar vandesign avatar zetok avatar znarf avatar zyeoman avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.