Ticket tracker with patchset contributions

A basic issue tracker styled as a hybrid of GitHub and BitBucket issues.
You may attach commits to an existing ticket or you can push a single
commit to create a *proposal* ticket.

Tickets keep track of patchsets (one or more commits) and allow patchset
rewriting (rebase, amend, squash) by detecing the non-fast-forward
update and assigning a new patchset number to the new commits.

Ticket tracker
--------------

The ticket tracker stores tickets as an append-only journal of changes.
The journals are deserialized and a ticket is built by applying the
journal entries.  Tickets are indexed using Apache Lucene and all
queries and searches are executed against this Lucene index.

There is one trade-off to this persistence design: user attributions are
non-relational.

What does that mean?  Each journal entry stores the username of the
author.  If the username changes in the user service, the journal entry
will not reflect that change because the values are hard-coded.

Here are a few reasons/justifications for this design choice:

1. commit identifications (author, committer, tagger) are non-relational
2. maintains the KISS principle
3. your favorite text editor can still be your administration tool

Persistence Choices
-------------------

**FileTicketService**: stores journals on the filesystem
**BranchTicketService**: stores journals on an orphan branch
**RedisTicketService**: stores journals in a Redis key-value datastore

It should be relatively straight-forward to develop other backends
(MongoDB, etc) as long as the journal design is preserved.

Pushing Commits
---------------

Each push to a ticket is identified as a patchset revision.  A patchset
revision may add commits to the patchset (fast-forward) OR a patchset
revision may rewrite history (rebase, squash, rebase+squash, or amend).
Patchset authors should not be afraid to polish, revise, and rewrite
their code before merging into the proposed branch.

Gitblit will create one ref for each patchset.  These refs are updated
for fast-forward pushes or created for rewrites.  They are formatted as
`refs/tickets/{shard}/{id}/{patchset}`.  The *shard*  is the last two
digits of the id.  If the id < 10, prefix a 0.  The *shard* is always
two digits long.  The shard's purpose is to ensure Gitblit doesn't
exceed any filesystem directory limits for file creation.

**Creating a Proposal Ticket**

You may create a new change proposal ticket just by pushing a **single
commit** to `refs/for/{branch}` where branch is the proposed integration
branch OR `refs/for/new` or `refs/for/default` which both will use the
default repository branch.

    git push origin HEAD:refs/for/new

**Updating a Patchset**

The safe way to update an existing patchset is to push to the patchset
ref.

    git push origin HEAD:refs/heads/ticket/{id}

This ensures you do not accidentally create a new patchset in the event
that the patchset was updated after you last pulled.

The not-so-safe way to update an existing patchset is to push using the
magic ref.

    git push origin HEAD:refs/for/{id}

This push ref will update an exisitng patchset OR create a new patchset
if the update is non-fast-forward.

**Rebasing, Squashing, Amending**

Gitblit makes rebasing, squashing, and amending patchsets easy.

Normally, pushing a non-fast-forward update would require rewind (RW+)
repository permissions.  Gitblit provides a magic ref which will allow
ticket participants to rewrite a ticket patchset as long as the ticket
is open.

    git push origin HEAD:refs/for/{id}

Pushing changes to this ref allows the patchset authors to rebase,
squash, or amend the patchset commits without requiring client-side use
of the *--force* flag on push AND without requiring RW+ permission to
the repository.  Since each patchset is tracked with a ref it is easy to
recover from accidental non-fast-forward updates.

Features
--------

- Ticket tracker with status changes and responsible assignments
- Patchset revision scoring mechanism
- Update/Rewrite patchset handling
- Close-on-push detection
- Server-side Merge button for simple merges
- Comments with Markdown syntax support
- Rich mail notifications
- Voting
- Mentions
- Watch lists
- Querying
- Searches
- Partial miletones support
- Multiple backend options

4 files changed, 110 insertions, 0 deletions

diff --git a/src/main/distrib/data/clientapps.json b/src/main/distrib/data/clientapps.json
index 2b15cd38..31e53efd 100644
--- a/src/main/distrib/data/clientapps.json
+++ b/src/main/distrib/data/clientapps.json
@@ -10,6 +10,17 @@
 		"isActive": true

 	},

 	{

+		"name": "Barnum",

+		"title": "Barnum",

+		"description": "a command-line Git companion for Gitblit Tickets",

+		"legal": "released under the Apache 2.0 License",

+		"command": "pt clone ${repoUrl}",

+		"productUrl": "http://barnum.gitblit.com",

+		"transports": [ "ssh" ],

+		"icon": "barnum_32x32.png",

+		"isActive": false

+	},	

+	{

 		"name": "SmartGit/Hg",

 		"title": "syntevo SmartGit/Hg\u2122",

 		"description": "a Git client for Windows, Mac, & Linux",

@@ -73,6 +84,7 @@
 		"legal": "released under the GPLv3 open source license",

 		"cloneUrl": "sparkleshare://addProject/${baseUrl}/sparkleshare/${repoUrl}.xml",

 		"productUrl": "http://sparkleshare.org",

+		"transports": [ "ssh" ],

 		"platforms": [ "windows", "macintosh", "linux" ],

 		"icon": "sparkleshare_32x32.png",

 		"minimumPermission" : "RW+",

diff --git a/src/main/distrib/data/gitblit.properties b/src/main/distrib/data/gitblit.properties
index 5a083264..73c6ebd5 100644
--- a/src/main/distrib/data/gitblit.properties
+++ b/src/main/distrib/data/gitblit.properties
@@ -429,6 +429,76 @@ git.streamFileThreshold = 50m
 # RESTART REQUIRED

 git.packedGitMmap = false

 

+# Use the Gitblit patch receive pack for processing contributions and tickets.

+# This allows the user to push a patch using the familiar Gerrit syntax:

+#

+#    git push <remote> HEAD:refs/for/<targetBranch>

+#

+# NOTE:

+# This requires git.enableGitServlet = true AND it requires an authenticated

+# git transport connection (http/https) when pushing from a client.

+#

+# Valid services include:

+#    com.gitblit.tickets.FileTicketService

+#    com.gitblit.tickets.BranchTicketService

+#    com.gitblit.tickets.RedisTicketService

+#

+# SINCE 1.4.0

+# RESTART REQUIRED

+tickets.service = 

+

+# Globally enable or disable creation of new bug, enhancement, task, etc tickets

+# for all repositories.

+#

+# If false, no tickets can be created through the ui for any repositories.

+# If true, each repository can control if they allow new tickets to be created.

+#

+# NOTE:

+# If a repository is accepting patchsets, new proposal tickets can be created

+# regardless of this setting.

+#

+# SINCE 1.4.0

+tickets.acceptNewTickets = true

+

+# Globally enable or disable pushing patchsets to all repositories.

+#

+# If false, no patchsets will be accepted for any repositories.

+# If true, each repository can control if they accept new patchsets.

+#

+# NOTE:

+# If a repository is accepting patchsets, new proposal tickets can be created

+# regardless of the acceptNewTickets setting.

+#

+# SINCE 1.4.0

+tickets.acceptNewPatchsets = true

+

+# Default setting to control patchset merge through the web ui.  If true, patchsets

+# must have an approval score to enable the merge button.  This setting can be

+# overriden per-repository.

+#

+# SINCE 1.4.0

+tickets.requireApproval = false

+

+# Specify the location of the Lucene Ticket index

+#

+# SINCE 1.4.0

+# RESTART REQUIRED

+tickets.indexFolder = ${baseFolder}/tickets/lucene

+

+# Define the url for the Redis server.

+#

+# e.g. redis://localhost:6379

+#      redis://:foobared@localhost:6379/2

+#

+# SINCE 1.4.0

+# RESTART REQUIRED

+tickets.redis.url =

+

+# The number of tickets to display on a page.

+#

+# SINCE 1.4.0

+tickets.perPage = 25

+

 #

 # Groovy Integration

 #

diff --git a/src/main/distrib/linux/reindex-tickets.sh b/src/main/distrib/linux/reindex-tickets.sh
new file mode 100644
index 00000000..15939291
--- /dev/null
+++ b/src/main/distrib/linux/reindex-tickets.sh
@@ -0,0 +1,15 @@
+#!/bin/bash
+# --------------------------------------------------------------------------
+# This is for reindexing Tickets with Lucene.
+#
+# Since the Tickets feature is undergoing massive churn it may be necessary 
+# to reindex tickets due to model or index changes.
+#
+# usage:
+#
+#     reindex-tickets.sh <baseFolder>
+#
+# --------------------------------------------------------------------------
+
+java -cp gitblit.jar:./ext/* com.gitblit.ReindexTickets --baseFolder $1
+
diff --git a/src/main/distrib/win/reindex-tickets.cmd b/src/main/distrib/win/reindex-tickets.cmd
new file mode 100644
index 00000000..e28f45f5
--- /dev/null
+++ b/src/main/distrib/win/reindex-tickets.cmd
@@ -0,0 +1,13 @@
+@REM --------------------------------------------------------------------------

+@REM This is for reindexing Tickets with Lucene.

+@REM

+@REM Since the Tickets feature is undergoing massive churn it may be necessary 

+@REM to reindex tickets due to model or index changes.

+@REM

+@REM Always use forward-slashes for the path separator in your parameters!!

+@REM

+@REM Set FOLDER to the baseFolder.

+@REM --------------------------------------------------------------------------

+@SET FOLDER=data

+

+@java -cp gitblit.jar;"%CD%\ext\*" com.gitblit.ReindexTickets --baseFolder %FOLDER%