James Moger
2013-12-09 5e3521f8496511db4df45f011ea72f25623ad90f
refs
author James Moger <james.moger@gitblit.com>
Monday, December 9, 2013 17:19 -0500
committer James Moger <james.moger@gitblit.com>
Monday, March 3, 2014 21:34 -0500
commit5e3521f8496511db4df45f011ea72f25623ad90f
tree 98b4f516d59833b5a8c1ccbcd45672e5b9f3add2 tree | zip | gz
parent 94e12c168f5eec300fd23d0de25c7dc93a96c429 view | diff
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
51 files added
38 files modified
17049 ■■■■■ changed files
.classpath 2 ●●●●● diff | view | raw | blame | history
NOTICE 17 ●●●●● diff | view | raw | blame | history
build.moxie 1 ●●●● diff | view | raw | blame | history
build.xml 14 ●●●●● diff | view | raw | blame | history
gitblit.iml 22 ●●●●● diff | view | raw | blame | history
releases.moxie 6 ●●●●● diff | view | raw | blame | history
src/main/distrib/data/clientapps.json 12 ●●●●● diff | view | raw | blame | history
src/main/distrib/data/gitblit.properties 70 ●●●●● diff | view | raw | blame | history
src/main/distrib/linux/reindex-tickets.sh 15 ●●●●● diff | view | raw | blame | history
src/main/distrib/win/reindex-tickets.cmd 13 ●●●●● diff | view | raw | blame | history
src/main/java/WEB-INF/web.xml 16 ●●●●● diff | view | raw | blame | history
src/main/java/com/gitblit/Constants.java 8 ●●●● diff | view | raw | blame | history
src/main/java/com/gitblit/GitBlit.java 154 ●●●●● diff | view | raw | blame | history
src/main/java/com/gitblit/ReindexTickets.java 183 ●●●●● diff | view | raw | blame | history
src/main/java/com/gitblit/client/EditRepositoryDialog.java 21 ●●●●● diff | view | raw | blame | history
src/main/java/com/gitblit/git/GitblitReceivePack.java 11 ●●●●● diff | view | raw | blame | history
src/main/java/com/gitblit/git/GitblitReceivePackFactory.java 11 ●●●● diff | view | raw | blame | history
src/main/java/com/gitblit/git/PatchsetCommand.java 324 ●●●●● diff | view | raw | blame | history
src/main/java/com/gitblit/git/PatchsetReceivePack.java 1129 ●●●●● diff | view | raw | blame | history
src/main/java/com/gitblit/manager/GitblitManager.java 10 ●●●●● diff | view | raw | blame | history
src/main/java/com/gitblit/manager/IGitblit.java 8 ●●●●● diff | view | raw | blame | history
src/main/java/com/gitblit/manager/RepositoryManager.java 12 ●●●●● diff | view | raw | blame | history
src/main/java/com/gitblit/models/RepositoryModel.java 11 ●●●●● diff | view | raw | blame | history
src/main/java/com/gitblit/models/TicketModel.java 1286 ●●●●● diff | view | raw | blame | history
src/main/java/com/gitblit/models/UserModel.java 12 ●●●●● diff | view | raw | blame | history
src/main/java/com/gitblit/servlet/PtServlet.java 201 ●●●●● diff | view | raw | blame | history
src/main/java/com/gitblit/tickets/BranchTicketService.java 799 ●●●●● diff | view | raw | blame | history
src/main/java/com/gitblit/tickets/FileTicketService.java 467 ●●●●● diff | view | raw | blame | history
src/main/java/com/gitblit/tickets/ITicketService.java 1088 ●●●●● diff | view | raw | blame | history
src/main/java/com/gitblit/tickets/NullTicketService.java 129 ●●●●● diff | view | raw | blame | history
src/main/java/com/gitblit/tickets/QueryBuilder.java 222 ●●●●● diff | view | raw | blame | history
src/main/java/com/gitblit/tickets/QueryResult.java 114 ●●●●● diff | view | raw | blame | history
src/main/java/com/gitblit/tickets/RedisTicketService.java 534 ●●●●● diff | view | raw | blame | history
src/main/java/com/gitblit/tickets/TicketIndexer.java 657 ●●●●● diff | view | raw | blame | history
src/main/java/com/gitblit/tickets/TicketLabel.java 77 ●●●●● diff | view | raw | blame | history
src/main/java/com/gitblit/tickets/TicketMilestone.java 53 ●●●●● diff | view | raw | blame | history
src/main/java/com/gitblit/tickets/TicketNotifier.java 617 ●●●●● diff | view | raw | blame | history
src/main/java/com/gitblit/tickets/TicketResponsible.java 59 ●●●●● diff | view | raw | blame | history
src/main/java/com/gitblit/tickets/TicketSerializer.java 175 ●●●●● diff | view | raw | blame | history
src/main/java/com/gitblit/tickets/commands.md 11 ●●●●● diff | view | raw | blame | history
src/main/java/com/gitblit/tickets/email.css 38 ●●●●● diff | view | raw | blame | history
src/main/java/com/gitblit/utils/JGitUtils.java 207 ●●●●● diff | view | raw | blame | history
src/main/java/com/gitblit/utils/JsonUtils.java 4 ●●●● diff | view | raw | blame | history
src/main/java/com/gitblit/utils/MarkdownUtils.java 4 ●●●● diff | view | raw | blame | history
src/main/java/com/gitblit/utils/RefLogUtils.java 40 ●●●● diff | view | raw | blame | history
src/main/java/com/gitblit/wicket/GitBlitWebApp.java 15 ●●●●● diff | view | raw | blame | history
src/main/java/com/gitblit/wicket/GitBlitWebApp.properties 141 ●●●●● diff | view | raw | blame | history
src/main/java/com/gitblit/wicket/pages/BasePage.java 25 ●●●●● diff | view | raw | blame | history
src/main/java/com/gitblit/wicket/pages/EditRepositoryPage.html 31 ●●●● diff | view | raw | blame | history
src/main/java/com/gitblit/wicket/pages/EditRepositoryPage.java 11 ●●●●● diff | view | raw | blame | history
src/main/java/com/gitblit/wicket/pages/EditTicketPage.html 66 ●●●●● diff | view | raw | blame | history
src/main/java/com/gitblit/wicket/pages/EditTicketPage.java 290 ●●●●● diff | view | raw | blame | history
src/main/java/com/gitblit/wicket/pages/ExportTicketPage.java 82 ●●●●● diff | view | raw | blame | history
src/main/java/com/gitblit/wicket/pages/NewTicketPage.html 66 ●●●●● diff | view | raw | blame | history
src/main/java/com/gitblit/wicket/pages/NewTicketPage.java 202 ●●●●● diff | view | raw | blame | history
src/main/java/com/gitblit/wicket/pages/NoTicketsPage.html 21 ●●●●● diff | view | raw | blame | history
src/main/java/com/gitblit/wicket/pages/NoTicketsPage.java 44 ●●●●● diff | view | raw | blame | history
src/main/java/com/gitblit/wicket/pages/RepositoryPage.html 1 ●●●● diff | view | raw | blame | history
src/main/java/com/gitblit/wicket/pages/RepositoryPage.java 20 ●●●●● diff | view | raw | blame | history
src/main/java/com/gitblit/wicket/pages/TicketBasePage.java 124 ●●●●● diff | view | raw | blame | history
src/main/java/com/gitblit/wicket/pages/TicketPage.html 577 ●●●●● diff | view | raw | blame | history
src/main/java/com/gitblit/wicket/pages/TicketPage.java 1527 ●●●●● diff | view | raw | blame | history
src/main/java/com/gitblit/wicket/pages/TicketsPage.html 215 ●●●●● diff | view | raw | blame | history
src/main/java/com/gitblit/wicket/pages/TicketsPage.java 878 ●●●●● diff | view | raw | blame | history
src/main/java/com/gitblit/wicket/pages/propose_git.md 6 ●●●●● diff | view | raw | blame | history
src/main/java/com/gitblit/wicket/pages/propose_pt.md 5 ●●●●● diff | view | raw | blame | history
src/main/java/com/gitblit/wicket/panels/CommentPanel.html 29 ●●●●● diff | view | raw | blame | history
src/main/java/com/gitblit/wicket/panels/CommentPanel.java 110 ●●●●● diff | view | raw | blame | history
src/main/java/com/gitblit/wicket/panels/DigestsPanel.java 539 ●●●● diff | view | raw | blame | history
src/main/java/com/gitblit/wicket/panels/GravatarImage.java 142 ●●●● diff | view | raw | blame | history
src/main/java/com/gitblit/wicket/panels/MarkdownTextArea.java 118 ●●●●● diff | view | raw | blame | history
src/main/java/com/gitblit/wicket/panels/ReflogPanel.html 4 ●●●● diff | view | raw | blame | history
src/main/java/com/gitblit/wicket/panels/ReflogPanel.java 638 ●●●● diff | view | raw | blame | history
src/main/java/com/gitblit/wicket/panels/RefsPanel.java 27 ●●●● diff | view | raw | blame | history
src/main/java/pt.cmd 1 ●●●● diff | view | raw | blame | history
src/main/java/pt.py 701 ●●●●● diff | view | raw | blame | history
src/main/java/pt.txt 49 ●●●●● diff | view | raw | blame | history
src/main/resources/barnum_32x32.png diff | view | raw | blame | history
src/main/resources/gitblit.css 412 ●●●●● diff | view | raw | blame | history
src/site/design.mkd 1 ●●●● diff | view | raw | blame | history
src/site/tickets_barnum.mkd 79 ●●●●● diff | view | raw | blame | history
src/site/tickets_overview.mkd 145 ●●●●● diff | view | raw | blame | history
src/site/tickets_setup.mkd 119 ●●●●● diff | view | raw | blame | history
src/site/tickets_using.mkd 155 ●●●●● diff | view | raw | blame | history
src/test/java/com/gitblit/tests/BranchTicketServiceTest.java 68 ●●●●● diff | view | raw | blame | history
src/test/java/com/gitblit/tests/FileTicketServiceTest.java 67 ●●●●● diff | view | raw | blame | history
src/test/java/com/gitblit/tests/GitBlitSuite.java 8 ●●●● diff | view | raw | blame | history
src/test/java/com/gitblit/tests/RedisTicketServiceTest.java 75 ●●●●● diff | view | raw | blame | history
src/test/java/com/gitblit/tests/TicketServiceTest.java 351 ●●●●● diff | view | raw | blame | history