Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/leif81/bzkanban

:bug: A kanban board for the Bugzilla issue tracker
https://github.com/leif81/bzkanban

agile bugzilla issue-board kanban project-management scrum server-less single-page-app web-app

Last synced: about 1 month ago
JSON representation

:bug: A kanban board for the Bugzilla issue tracker

Awesome Lists containing this project

README 

        
= Bz Kanban Board



== About



The bzkanban app allows you to visualize Bugzilla bugs as cards on a Kanban board.



The board columns are the bug statuses your Bugzilla server is using (e.g. NEW, ASSIGNED, REOPENED, RESOLVED, CLOSED, etc).



Actions such as loading the board, filtering by bug assignee or by bug title are possible without logging in if your Bugzilla server is open to the public.

Otherwise you must login with your Bugzilla account first.



Actions such as changing the bug state (by dragging the card between columns), and adding a comment require logging in first.



The bzkanban app is implemented as a client side Single-Page Application (SPA) with the http://bugzilla.readthedocs.io/en/latest/api/index.html[Bugzilla 5 server REST API].

So what?

Installation is simple.

See the Installation section below for steps.



== Screenshot



image::screenshot.png[title="bzkanban example board"]



== Demo



Note: These below links are to live production Bugzilla instances, viewed with bzkanban.

Any changes made will be applied to the production Bugzilla instance with your account, so apply the same careful consideration as you would when using the native Bugzilla UI.



- https://leif81.github.io/bzkanban/index.html?product=Bugzilla&milestone=Bugzilla+6.0&assignee=&comments=false&site=https%3A%2F%2Fbugzilla.mozilla.org[Mozilla Bugzilla]



- https://leif81.github.io/bzkanban/index.html?site=https://bugzilla.redhat.com/[Red Hat Bugzilla]



== Requirements



 . Client: A modern web browser capable of HTML5, CSS3, and JavaScript (tested with Chrome and Edge)

 . Server: Access to the Bugzilla 5.0+ server with the REST API enabled.



== Installation



Chose one of the following options to use the Bzkanban app.



=== No install! Cloud version



This is the easiest way to both try and use bzkbanban app.



Your Bugzilla server URL must be accessible from the internet (not a private intranet) for this option to work.



1. Copy this address `https://leif81.github.io/bzkanban/index.html?site=https://bugzilla.mozilla.org`. Change the `site=` parameter to be the address of your Bugzilla server.

1. In your web browser, paste and load this URL.

1. Bookmark and share this URL with your team.



Note: This method uses the latest version of the source code in the GitHub `master` branch. You will always have the latest fixes and enhancements when you reload the app URL. The intent is the `master` branch is kept stable although there's no gaurantee. Please report any issues using the GitHub issue tracker and include a proposed PR for the quickest resolution to the issue.



== Locally hosted



Use this method if your Bugzilla server is on a private intranet.



 . Clone this git repo onto your web server.

 . Open `bzkbanban/index.html` and change the `siteUrl` option to the address of your Bugzilla instance.

 . Start your web server (Note: A simple option is by running `npm http-server` within the bzkanban folder where the `index.html` file is)

 . In your web browser navigate to the address of the `index.html` file (i.e. `http://www.mycompany.com/bzkbanban/index.html`). Bookmark it! 

 

Note: To update the app, periodically do a "git pull" to receive the latest updates from the `master` branch.



== Use



=== Basic board access



 1. In your web browser, navigate to the bzkanban app URL you bookmarked above.

 1. Load a board by picking a product from the 'Product' list and a milestone from the 'Milestone' list.



=== Board filtering



 . Filter cards by the assignee with the 'Assignee' list. Clear the filter by choosing "ALL".

 . Filter cards by text words with the "Search Cards" text search box.



=== Bug modification



 . Bugs can be modified by modifying the original bug in Bugzilla and then reloading the bzkanban board, or with bzkanban app.

 . Within the bzkanban app, click the log in button (top right) and enter your Bugzilla user account details.

 . To add a comment, click on a card to open it and enter a new comment.

 . To modify the bug state, drag a card between columns.



== Configuration



These are some settings that can be manually controlled via the page URL parameters. To apply these permanently modify them in the top section of the `bzkanban.js` file.



 * `site`

 ** The Bugzilla instance to load data from. Overrides the `siteUrl` setting. e.g. `site=https://bugzilla.mozilla.org`

 * `comments`

 ** Show comment counts on cards. WARNING: it's expensive, one more request per card. e.g. `comments=true/false`

 * `autorefresh`

 ** Reload the board when external changes to bugs are detected. e.g. `autorefresh=true/false`