schacon / git-lighthouse

A tool to help work with git projects that accept patches from Lighthouse

This URL has Read+Write access

git-lighthouse / README.txt
raw normal view history
30571e58 » schacon 2008-05-27 initial commit 1 = git-lighthouse
2
3 * http://github.com/schacon/git-lighthouse
4
5 == DESCRIPTION:
6
7 Provides command line access to a Lighthouse ticketing system
8 for a git based software package. Allows you to list, view and
3d429680 » schacon 2008-05-27 updated readme 9 apply new patches that were submitted to Lighthouse.
30571e58 » schacon 2008-05-27 initial commit 10
24df6a51 » schacon 2008-05-27 added checkout functionality 11 == SYNOPSIS:
30571e58 » schacon 2008-05-27 initial commit 12
24df6a51 » schacon 2008-05-27 added checkout functionality 13 First, setup your Lighthouse data in your git repo:
30571e58 » schacon 2008-05-27 initial commit 14
24df6a51 » schacon 2008-05-27 added checkout functionality 15 git config lighthouse.account rails
16 git config lighthouse.projectId 8994
17 git config lighthouse.email name@email.com
18 git config lighthouse.password asdqwe
19
3d429680 » schacon 2008-05-27 updated readme 20 You can also setup an alias, if you prefer 'git lh' to 'git-lh':
21
efc74f4d » schacon 2008-05-27 updated todos 22 git config --global alias.lh '!git-lh'
3d429680 » schacon 2008-05-27 updated readme 23
eeab1fac » schacon 2008-05-27 clarified which tickets it ... 24 Then, you can list open tickets with patches
25 (they must be 'open' and have the tag 'patch' - at some point I'll make this configurable):
24df6a51 » schacon 2008-05-27 added checkout functionality 26
27 $ git-lh list
28
29 Date Num Attch Title
30 05/01 87 1 Dependencies shouldn't swallow errors from required files.
31 05/02 94 2 quote_string don't work with some postgres drivers
32 05/08 142 1 belongs_to association not updated when assigning to foreign key
33 05/14 191 0 Belongs to polymorphic association assignment with new records doesn't
34 05/14 192 1 AR Test failure on latest mysql
35
36 You can show one of the tickets:
37
38 $ git-lh show 94
39
40 Title : quote_string don't work with some postgres drivers
41 Number : 94
42
43 URL : http://rails.lighthouseapp.com/projects/8994/tickets/94
44 Created : Fri May 02 08:24:20 UTC 2008
45 State : open
46 Tags : activerecord patch
47
48 -- Attachments --
49
50 1 : quote_string_fix.diff
51 2 : postgres.so
52
53
54 You can get an attachment:
55
56 $ git-lh attachment 94 1 > quote_string_fix.diff
57
58 You can checkout an attachment - this will automatically stash whatever you're
59 working on, checkout a new branch called 'ticket94' and run either 'git am' or
60 'git apply', depending on what kind of patch file it is.
61
62 $ git-lh checkout 94 1
63
3d429680 » schacon 2008-05-27 updated readme 64 This will also checkout the commit closest to the date that the patch was uploaded,
65 which helps them apply cleanly.
30571e58 » schacon 2008-05-27 initial commit 66
67 == REQUIREMENTS:
68
04f61554 » schacon 2008-05-27 updated readme to make git ... 69 * Ruby/Git >= 1.0.7
30571e58 » schacon 2008-05-27 initial commit 70
71 == INSTALL:
72
04f61554 » schacon 2008-05-27 updated readme to make git ... 73 * sudo gem install schacon-git --source=http://gems.github.com
24df6a51 » schacon 2008-05-27 added checkout functionality 74 * sudo gem install schacon-git-lighthouse --source=http://gems.github.com
30571e58 » schacon 2008-05-27 initial commit 75
3d429680 » schacon 2008-05-27 updated readme 76 == TODO:
77
78 Eventually, I will try to add this functionality, too:
79
efc74f4d » schacon 2008-05-27 updated todos 80 * add comments to a ticket, including '+1's
81 * create a new ticket
82 * upload a new version of a patch, a set of patches, or an extra patch
83 * apply several/all patches from a ticket
eeab1fac » schacon 2008-05-27 clarified which tickets it ... 84 * make the tag for patches configurable
3d429680 » schacon 2008-05-27 updated readme 85
d5d73de2 » schacon 2008-05-27 removed a bunch of the newg... 86 == AUTHORS:
87
88 * Scott Chacon (schacon@gmail.com)
89
30571e58 » schacon 2008-05-27 initial commit 90 == LICENSE:
91
92 (The MIT License)
93
94 Copyright (c) 2008 Scott Chacon
95
96 Permission is hereby granted, free of charge, to any person obtaining
97 a copy of this software and associated documentation files (the
98 'Software'), to deal in the Software without restriction, including
99 without limitation the rights to use, copy, modify, merge, publish,
100 distribute, sublicense, and/or sell copies of the Software, and to
101 permit persons to whom the Software is furnished to do so, subject to
102 the following conditions:
103
104 The above copyright notice and this permission notice shall be
105 included in all copies or substantial portions of the Software.
106
107 THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
108 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
109 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
110 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
111 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
112 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
eeab1fac » schacon 2008-05-27 clarified which tickets it ... 113 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.