Skip to content
Newer
Older
100644 428 lines (265 sloc) 21.5 KB
98b5b1a @jeffWelling Improving README
jeffWelling authored Feb 14, 2011
1 ## TicGit-ng ##
a132ae4 Improved documentation
jeff authored Sep 6, 2010
2
3 This project provides a ticketing system built on Git that is kept in a
98b5b1a @jeffWelling Improving README
jeffWelling authored Feb 15, 2011
4 separate branch in your projects Git repository. Originally called TicGit,
5 it is now known as TicGit-ng to continue development and avoid namespace
6 clashes.
a132ae4 Improved documentation
jeff authored Sep 6, 2010
7
d85010c Added About section from schacons wiki to README
jeff authored Sep 6, 2010
8 ### About ###
9
9963b19 @jeffWelling Finished going through readme renaming to ticgit-ng
jeffWelling authored Feb 14, 2011
10 TicGit-ng is a simple ticketing system, roughly similar to the Lighthouse model, that is based in git. It provides a command line client that uses the ‘git’ gem to keep its ticketing information in a separate branch (called ‘ticgit-ng’) within your existing git repository. All the data is file based and rarely changing, decreasing the likelihood of a merge issue. Right now, ticket branch merges need to be done manually and separately, but work is being done on a `ti sync` command to make this easier and more intuitive.
d85010c Added About section from schacons wiki to README
jeff authored Sep 6, 2010
11
12 The idea is that it keeps your tickets in the same repository, but without mucking up your working tree. By using its own seperate branch to store its information it keeps the working trees in all your other branches untouched.
13
14 There are two interfaces available, the command line `ti` command and the `ticgitweb` web interface, though `ticgitweb` has many more prerequisites than `ti`.
15
9963b19 @jeffWelling Finished going through readme renaming to ticgit-ng
jeffWelling authored Feb 15, 2011
16 It will automatically create the new branch the first time you use it, and it caches all the data (another working directory and index file) in your ~/.ticgit-ng directory by default. If you delete that directory, it will just create it again the next time, you will lose no data (except some of your saved preferences).
d85010c Added About section from schacons wiki to README
jeff authored Sep 6, 2010
17
9963b19 @jeffWelling Finished going through readme renaming to ticgit-ng
jeffWelling authored Feb 15, 2011
18 TicGit-ng is currently using itself to store its feature requests and bug reports.
a132ae4 Improved documentation
jeff authored Sep 6, 2010
19
2e3215a Added prerequisites section again - got overwritten when moving READM…
jeff authored Sep 6, 2010
20 ### Prerequisites ###
21
ddf128f @jeffWelling Updated Prerequisites
jeffWelling authored Oct 25, 2010
22 There are two sets of prerequisites, those for people who intend to just run `ti`, and another set for those who wish to run `ticgitweb` as well. `ticgitweb` has additional dependancies that aren't required for `ti`'s use.
23
e943f0f @jeffWelling Trying a style fix
jeffWelling authored Oct 25, 2010
24 **ti**
ddf128f @jeffWelling Updated Prerequisites
jeffWelling authored Oct 26, 2010
25
4af388d @jeffWelling Trying to improve Prerequisites section in README
jeffWelling authored Oct 25, 2010
26 Required Packages: git, ruby, rubygems
bf8c69a @jeffWelling Fixed some things in README
jeffWelling authored Oct 25, 2010
27
4af388d @jeffWelling Trying to improve Prerequisites section in README
jeffWelling authored Oct 26, 2010
28 Required Ruby Gems: git
2e3215a Added prerequisites section again - got overwritten when moving READM…
jeff authored Sep 6, 2010
29
4af388d @jeffWelling Trying to improve Prerequisites section in README
jeffWelling authored Oct 26, 2010
30 To install these packages on a Debian system, or a Debian based system like Ubuntu, do
2e3215a Added prerequisites section again - got overwritten when moving READM…
jeff authored Sep 6, 2010
31
26308c0 Updated Install instructions
Alec Clews authored Apr 10, 2011
32 sudo apt-get install git ruby rubygems
4af388d @jeffWelling Trying to improve Prerequisites section in README
jeffWelling authored Oct 26, 2010
33 sudo gem install git
34
25f30c5 @jeffWelling Improved note about installing rubygems
jeffWelling authored Apr 11, 2011
35 If you are installing rubygems for the first time or are troubleshooting, please see the note about installing rubygems below.
d674110 Updated Install for Debian and Ubuntu
Alec Clews authored Apr 11, 2011
36
e943f0f @jeffWelling Trying a style fix
jeffWelling authored Oct 26, 2010
37 **ticgitweb**
ddf128f @jeffWelling Updated Prerequisites
jeffWelling authored Oct 26, 2010
38
39 Required Packages: git, ruby, rubygems
40
41 Required Ruby Gems: git, sinatra, haml, sass
42
43 To install these packages on a Debian system, or a Debian based system like Ubuntu, do
44
26308c0 Updated Install instructions
Alec Clews authored Apr 9, 2011
45 sudo apt-get install git ruby rubygems
46 sudo gem install git sinatra haml
25f30c5 @jeffWelling Improved note about installing rubygems
jeffWelling authored Apr 11, 2011
47 sudo gem install sass --pre
48
49 If you are installing rubygems for the first time or are troubleshooting, please see the note about installing rubygems below.
50
51 **A Note about installing rubygems**
52
53 After installing rubygems it is necessary to update the PATH environment variable so that the scripts can be found. Add the following line to the end of your .bachrc file or equivalent. This is also relevent if you are getting errors about "the program is not installed" even though you just installed it. The reason this is required is because rubygems does not add the gems bin path to $PATH.
54
55 PATH=$PATH:/var/lib/gems/1.8/bin
ddf128f @jeffWelling Updated Prerequisites
jeffWelling authored Oct 26, 2010
56
ff74483 @jeffWelling Clarified 'a note about rubygems' to 'a note about rubygems on Debian…
jeffWelling authored Apr 11, 2011
57 **A Note about rubygems on Debian Version < 6.0**
bf8c69a @jeffWelling Fixed some things in README
jeffWelling authored Oct 26, 2010
58
4af388d @jeffWelling Trying to improve Prerequisites section in README
jeffWelling authored Oct 26, 2010
59 While the version of rubygems available from the repositories on Debian 5.0.5 stable will work just fine for using the command line `ti` program, using `ticgitweb` requires some extra effort.
60 Older versions of rubygems, such as the one available on Debian 5.0.5, will not work out of the box with the new gem repositories because the .deb in stable relies on rubyforge rather than rubygems for its operations. See [this bug](http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=558251) for an example. If you are running an older version of rubygems, you may need to get the latest rubygems package from http://rubygems.org/ or [apt](http://jaqque.sbih.org/kplug/apt-pinning.html) [pinning](http://jeffwelling.github.com//2010/09/05/Apt-Pinning.html) before being able to properly install the git and ticgit gems.
61
7033e26 @jeffWelling Bump version, added to readme
jeffWelling authored Nov 9, 2011
62 **A Note About The Git Gem**
bf8c69a @jeffWelling Fixed some things in README
jeffWelling authored Oct 26, 2010
63
b9f5301 @jeffWelling Added note about the git version that the git gem needs and the notic…
jeffWelling authored Sep 6, 2010
64 The git gem requires a git version of 1.6.0.0 or later, but on Debian stable, git-core is currently (Sept 6th 2010) at 1.5.6.5. This isn't a fatal problem and we can continue using version 1.5.6.5 with the git gem, but you will see notices like this if you do
65
66 [WARNING] The git gem requires git 1.6.0.0 or later, but only found 1.5.6.5. You should probably upgrade.
67 Please specify at least one action to execute.
68
4af388d @jeffWelling Trying to improve Prerequisites section in README
jeffWelling authored Oct 26, 2010
69 If these annoy you as they do me and you've set up [apt](http://jaqque.sbih.org/kplug/apt-pinning.html) [pinning](http://jeffwelling.github.com//2010/09/05/Apt-Pinning.html), you can do
b9f5301 @jeffWelling Added note about the git version that the git gem needs and the notic…
jeffWelling authored Sep 7, 2010
70
d674110 Updated Install for Debian and Ubuntu
Alec Clews authored Apr 11, 2011
71 sudo apt-get -t testing install git-core
b9f5301 @jeffWelling Added note about the git version that the git gem needs and the notic…
jeffWelling authored Sep 7, 2010
72
73 And those notices should go away.
2e3215a Added prerequisites section again - got overwritten when moving READM…
jeff authored Sep 6, 2010
74
7033e26 @jeffWelling Bump version, added to readme
jeffWelling authored Nov 10, 2011
75 **A Note About Coloured Git Output**
4af388d @jeffWelling Trying to improve Prerequisites section in README
jeffWelling authored Oct 26, 2010
76
7033e26 @jeffWelling Bump version, added to readme
jeffWelling authored Nov 10, 2011
77 If you use `[color] ui = always` instead of `[color] ui = true` then you will encounter a problem with the deprecated git gem parsing the color codes. Because it doesn't strip the color codes before parsing the output, it chokes and makes everything explode.
bf8c69a @jeffWelling Fixed some things in README
jeffWelling authored Oct 26, 2010
78
7033e26 @jeffWelling Bump version, added to readme
jeffWelling authored Nov 10, 2011
79 Since time spent working on monkeypatching the git gem would soon be rendered fruitless by the eventual planned upgrade away from it, for the time being the suggested solution is to use `[color] ui = true`.
bf8c69a @jeffWelling Fixed some things in README
jeffWelling authored Oct 26, 2010
80
b181062 @jeffWelling Updated Installation section in README for gem install TicGit-ng
jeffWelling authored Feb 16, 2011
81 ### Installing ##
82 Installation on a Debian stable system. Note that the command line interface for TicGit-ng can be run from Debian stable, but some of the gems required for the web interface may require you to use [apt](http://jaqque.sbih.org/kplug/apt-pinning.html) [pinning](http://jeffwelling.github.com//2010/09/05/Apt-Pinning.html) to run without errors. See below
a132ae4 Improved documentation
jeff authored Sep 6, 2010
83
b181062 @jeffWelling Updated Installation section in README for gem install TicGit-ng
jeffWelling authored Feb 17, 2011
84 To install TicGit-ng on your system, you can go one of two ways,
a132ae4 Improved documentation
jeff authored Sep 6, 2010
85
aa3b7e5 @alecthegeek Added sudo when installing ticgit gem
alecthegeek authored Apr 7, 2011
86 $ sudo gem install TicGit-ng
7ad0997 @jeffWelling Added note about using the preferred installation method
jeffWelling authored Sep 7, 2010
87
b181062 @jeffWelling Updated Installation section in README for gem install TicGit-ng
jeffWelling authored Feb 17, 2011
88 or, you can install it from source by downloading this repository building your own gem (see below).
7ad0997 @jeffWelling Added note about using the preferred installation method
jeffWelling authored Sep 7, 2010
89
a132ae4 Improved documentation
jeff authored Sep 6, 2010
90 ### Usage ###
91
92 To get a list of all commands with short description:
93
94 > ti --help
95 Usage: ti COMMAND [FLAGS] [ARGS]
96
97 Options for help command:
98
9963b19 @jeffWelling Finished going through readme renaming to ticgit-ng
jeffWelling authored Feb 15, 2011
99 The available TicGit-ng commands are:
a132ae4 Improved documentation
jeff authored Sep 6, 2010
100 recent List recent activities
101 checkout Checkout a ticket
102 tag Modify tags of a ticket
103 comment Comment on a ticket
104 milestone List and modify milestones
105 assign Assings a ticket to someone
106 points Assign points to a ticket
107 state Change state of a ticket
108 show Show a ticket
109 new Create a new ticket
110 attach Attach file to ticket
111 list List tickets
53632e1 @jeffWelling Touch ups to the README
jeffWelling authored Apr 11, 2011
112 sync Sync tickets
a132ae4 Improved documentation
jeff authored Sep 6, 2010
113
114 Common options:
115 -v, --version Show the version number
116 -h, --help Display this help
117 "help" is not a command
118
119
120 To get help about a specific command:
121
122 > ti <command> --help
123 ## for example
124 > ti assign --help
125 Usage: ti assign [options] [ticket_id]
126
127 Options for assign command:
128 -c, --checkout TICKET Checkout this ticket
129 -u, --user USER Assign the ticket to this user
130
131 Common options:
132 -v, --version Show the version number
133 -h, --help Display this help
134
135
0aba4ff @jeffWelling Fixed bit at the bottom about the available commands
jeffWelling authored Sep 6, 2010
136 The available commands are:
137
138 ti list - show all tickets
139 ti show - show details of a specific ticket
140 ti new - create a new ticket
141 ti checkout - checkout a ticket
142 ti state - change a ticket state (open, resolved, invalid, hold)
143 ti comment - add a comment to a ticket
144 ti tag - add or delete a tag from a ticket
145 ti assign - change to whom a ticket is assigned
53632e1 @jeffWelling Touch ups to the README
jeffWelling authored Apr 11, 2011
146 ti sync - sync tickets with a remote repo
a132ae4 Improved documentation
jeff authored Sep 6, 2010
147
148
af0b4ba Updated Authors header, and added Usage Examples section
jeff authored Sep 6, 2010
149 ### Usage Examples ###
150
9963b19 @jeffWelling Finished going through readme renaming to ticgit-ng
jeffWelling authored Feb 15, 2011
151 The first time you use any command in Ticgit-ng, it will create a new branch in your repo called ‘ticgit-ng’ and setup a caching area in ~/.ticgit-ng.
af0b4ba Updated Authors header, and added Usage Examples section
jeff authored Sep 6, 2010
152
153 If you run it without arguments, it will tell you what is available to run
154
155 $ ti
156 Please specify at least one action to execute.
157
158 Usage: ti COMMAND [FLAGS] [ARGS]
159
9963b19 @jeffWelling Finished going through readme renaming to ticgit-ng
jeffWelling authored Feb 15, 2011
160 The available TicGit-ng commands are:
af0b4ba Updated Authors header, and added Usage Examples section
jeff authored Sep 6, 2010
161 recent List recent activities
162 checkout Checkout a ticket
163 tag Modify tags of a ticket
164 comment Comment on a ticket
165 milestone List and modify milestones
166 assign Assings a ticket to someone
167 points Assign points to a ticket
168 state Change state of a ticket
169 show Show a ticket
170 new Create a new ticket
171 attach Attach file to ticket
172 list List tickets
53632e1 @jeffWelling Touch ups to the README
jeffWelling authored Apr 11, 2011
173 sync Sync tickets
af0b4ba Updated Authors header, and added Usage Examples section
jeff authored Sep 6, 2010
174
175 Common options:
176 -v, --version Show the version number
177 -h, --help Display this help
178
179 The first time you run `ti list`, it will show an empty list.
180
181 $ ti list
182 I, [2010-09-06T15:47:52.075485 #4820] INFO -- : creating ticgit repo branch
183
184 TicId Title State Date Assgn Tags
185 -----------------------------------------------------------------------------------------
186
1e555e5 @jeffWelling Broke out mention of how not using -m brings up an editor into a full…
jeffWelling authored Sep 6, 2010
187 To add a new ticket you can use `ti new -t 'Title of ticket'` and give it a title in one command line.
af0b4ba Updated Authors header, and added Usage Examples section
jeff authored Sep 6, 2010
188
189 $ ti new -t 'my new ticket'
190 $ ti list
191
192 TicId Title State Date Assgn Tags
193 -----------------------------------------------------------------------------------------
194 d7f2d8 my new ticket open 09/06
195
1e555e5 @jeffWelling Broke out mention of how not using -m brings up an editor into a full…
jeffWelling authored Sep 7, 2010
196 For the ‘comment’ and ‘new’ commands, if you don’t specify a ‘-m’ for the message, it puts you into $EDITOR to write it. The ‘new’ action is especially useful with this, because you can also tag it and give it an initial comment when you create it this way:
197
198
199 # ---
200 # tags:
201 # # first line will be the title of the tic, the rest will be the first comment
202 # # if you would like to add initial tags, put them on the 'tags:' line, comma delim
203 #
af0b4ba Updated Authors header, and added Usage Examples section
jeff authored Sep 6, 2010
204
78206b7 @jeffWelling Added note about best practice being checkout the ticket your working…
jeffWelling authored Sep 6, 2010
205 To edit a ticket, such as assigning a tag to the new ticket we created, we first checkout the ticket and then use `ti tag`.
206 Always checkout the ticket you intend to edit. Some commands allow you to include a tic_id argument but that can get confusing to keep track of and most of the time several edits will be done to the same ticket anyway, so it is suggested you use `ti checkout` for convenience if nothing else.
573fba3 @jeffWelling Added example usage or assigning a tag
jeffWelling authored Sep 6, 2010
207
208 #ti checkout can checkout tickets based on the TicId or based on it's place in the list
209 $ ti checkout 1
210 #checks out the first ticket, or to do the same thing by using the TicId
211 $ ti checkout d7f2d8
212 #then assign the tag
213 $ ti tag 'bug'
214 #and view the result..
215 $ ti list
216
217 TicId Title State Date Assgn Tags
218 -------------------------------------------------------------------------------------------------------
219 * d7f2d8 my new ticket open 09/06 bug
220
221
520c782 @jeffWelling Filled in more usage examples, added mention of 'ti sync' command tha…
jeffWelling authored Sep 6, 2010
222 To assign the ticket to someone, use the `ti assign` command. I assign the ticket to myself below.
223
224 $ ti assign -u 'jeff.welling@gmail.com'
225 $ ti list
226
227 TicId Title State Date Assgn Tags
228 ----------------------------------------------------------------------------------------------------------
229 * d7f2d8 my new ticket open 09/06 jeff.we… bug
230
231
232 To change the state of a ticket, such as to change it from 'open' to 'hold' or 'resolved', use `ti state`. There are 4 valid states: hold, invalid, open, and resolved.
233
234 $ ti state hold
235 $ ti list
236
237 TicId Title State Date Assgn Tags
238 ----------------------------------------------------------------------------------------------------------
239
240 *Dramatic Gasp!*
241 Where did all of our tickets go? Don't worry, this isn't a bug and your tickets aren't gone.
242
243 $ ti list --states open,hold
244
245 TicId Title State Date Assgn Tags
246 ----------------------------------------------------------------------------------------------------------
247 * d7f2d8 my new ticket hold 09/06 jeff.we… bug
248
249 By default `ti list` doesn't show tickets with a state of 'hold', so we have to specify that we want to see those tickets with an argument. Now you can see, out `ti state hold` command changed the state of that ticket to on hold. This can also be done without checking out the ticket by using `ti state 1 hold`.
250
251 Where ticgit expects a ticket id, it will take either the number of the ticket on the last ‘list’ you did, or it will take the partial sha each ticket is assigned when it is created – that number never changes for the life of the ticket, even across repositories, so you can email that number to someone else working on the project so they can identify it. If nothing is specified, it will use the currently checked out ticket.
252
253 $ ti comment -m "I'm a new comment"
254 $ ti show
255 Title: my new ticket
256 TicId: d7f2d8f6d6ec3da1a1800a33fb090d590a533bac
257
258 Assigned: jeff.welling@gmail.com
259 Opened: Mon Sep 06 15:52:03 -0700 2010 (0 days)
260 State: OPEN
261 Points: no estimate
262 Tags: bug
263
264 Comments (1):
265 * Added 09/06 18:34 by jeff.welling@gmail.com
266 I'm a new comment
267
268 `ti show` also has a '-f' argument to be able to see comments that are longer than 3 lines, which would normally be truncated.
269
270 The `ti list` command can also be sorted and filtered.
271
272 $ ti list --help
273 Usage: ti list [options]
274
275 Options for list command:
276 -l, --list Show the saved queries
277 -S, --saveas SAVENAME Save this list as a saved name
278 -a, --assigned ASSIGNED List only tickets assigned to someone
279 -s, --states STATE[,STATE] List only tickets in a specific state(s)
280 Prefix the state with '-' to negate
281 -t, --tags TAG[,TAG] List only tickets with specific tag(s)
282 Prefix the tag with '-' to negate
283 -o, --order ORDER Field to order by - one of : assigned,state,date,title
284
285 Common options:
286 -v, --version Show the version number
287 -h, --help Display this help
288
289 So if you wanted to see a list of all your tickets that have the ‘feature’ tag, assigned to ‘jeff.welling@gmail.com’ and are ‘open’, ordered by date opened descending, and save that view as ‘not_mine’, you can run this:
290
291 $ ti list -t feature -s open -a jeff.welling@gmail.com -o date.desc -S not_mine
292
293 Then if you want to later list tickets with the same options as you used above, use
294
295 $ ti list not_mine
296
297 ## Collaboration ##
298
9963b19 @jeffWelling Finished going through readme renaming to ticgit-ng
jeffWelling authored Feb 15, 2011
299 If you have cloned a repository and would like to get the ticgit-ng branch for that repo (presuming they have one), do this.
520c782 @jeffWelling Filled in more usage examples, added mention of 'ti sync' command tha…
jeffWelling authored Sep 7, 2010
300
9963b19 @jeffWelling Finished going through readme renaming to ticgit-ng
jeffWelling authored Feb 15, 2011
301 $git branch ticgit-ng origin/ticgit-ng
520c782 @jeffWelling Filled in more usage examples, added mention of 'ti sync' command tha…
jeffWelling authored Sep 7, 2010
302
9963b19 @jeffWelling Finished going through readme renaming to ticgit-ng
jeffWelling authored Feb 15, 2011
303 This will create a ticgit-ng branch in your local repo based on the ticgit-ng branch in origin. Now you can run `ti list` and it will show you the ticgit-ng tickets for that repository.
520c782 @jeffWelling Filled in more usage examples, added mention of 'ti sync' command tha…
jeffWelling authored Sep 7, 2010
304
9963b19 @jeffWelling Finished going through readme renaming to ticgit-ng
jeffWelling authored Feb 15, 2011
305 ### Getting the TicGit-ng ticgit-ng branch ##
70efd53 @jeffWelling Added section in the README about getting TicGit-ng's ticgit branch
jeffWelling authored Feb 9, 2011
306
307 To download your own copy of the TicGit-ng ticgit branch after cloning the repo, so that you can add or alter a bug yourself, follow these instructions.
308
9963b19 @jeffWelling Finished going through readme renaming to ticgit-ng
jeffWelling authored Feb 15, 2011
309 This will checkout a ticgit-ng branch and set it to track the ticgit-ng branch upstream in origin, and then checks out the master branch. You must checkout the master branch because TicGit-ng gets confused if you are already in the ticgit-ng branch when running TicGit-ng.
70efd53 @jeffWelling Added section in the README about getting TicGit-ng's ticgit branch
jeffWelling authored Feb 9, 2011
310
9963b19 @jeffWelling Finished going through readme renaming to ticgit-ng
jeffWelling authored Feb 15, 2011
311 $ git checkout origin/ticgit-ng
312 $ git checkout -b ticgit-ng
a5b76b0 @jeffWelling Note about not being in ticgit branch when using ticgit
jeffWelling authored Feb 9, 2011
313 $ git checkout master
70efd53 @jeffWelling Added section in the README about getting TicGit-ng's ticgit branch
jeffWelling authored Feb 9, 2011
314
9963b19 @jeffWelling Finished going through readme renaming to ticgit-ng
jeffWelling authored Feb 15, 2011
315 This will show you all of the bugs in TicGit-ng's ticgit-ng branch.
70efd53 @jeffWelling Added section in the README about getting TicGit-ng's ticgit branch
jeffWelling authored Feb 9, 2011
316
317 $ ti list
318
9963b19 @jeffWelling Finished going through readme renaming to ticgit-ng
jeffWelling authored Feb 15, 2011
319 To submit your changes back to the upstream maintainer, push the bugs in your ticgit-ng branch to your public repo on Github
70efd53 @jeffWelling Added section in the README about getting TicGit-ng's ticgit branch
jeffWelling authored Feb 9, 2011
320
9963b19 @jeffWelling Finished going through readme renaming to ticgit-ng
jeffWelling authored Feb 15, 2011
321 $ git push origin ticgit-ng
70efd53 @jeffWelling Added section in the README about getting TicGit-ng's ticgit branch
jeffWelling authored Feb 9, 2011
322
323 Then contact the upstream maintainer by sending a Pull Request or Email and ask them to review and accept your bug changes.
520c782 @jeffWelling Filled in more usage examples, added mention of 'ti sync' command tha…
jeffWelling authored Sep 7, 2010
324
325 ### Sharing your tickets with others ###
326
9963b19 @jeffWelling Finished going through readme renaming to ticgit-ng
jeffWelling authored Feb 15, 2011
327 Sharing your ticgit tickets with other people is as easy as asking them either creating their ticgit-ng branch based on yours if they haven't already started their own ticgit-ng branch, or pulling your ticgit-ng branch into theirs.
520c782 @jeffWelling Filled in more usage examples, added mention of 'ti sync' command tha…
jeffWelling authored Sep 7, 2010
328
9963b19 @jeffWelling Finished going through readme renaming to ticgit-ng
jeffWelling authored Feb 15, 2011
329 If you host your repositories on [Github](http://www.github.com) as I do then this process is simplified some because you don't have to worry about hosting your repository somewhere where other people can access it to pull your ticgit-ng branch.
520c782 @jeffWelling Filled in more usage examples, added mention of 'ti sync' command tha…
jeffWelling authored Sep 7, 2010
330
9963b19 @jeffWelling Finished going through readme renaming to ticgit-ng
jeffWelling authored Feb 15, 2011
331 For example, when I want my friend wnight to have the changes I made to my tickets in my ticgit-ng repository, I do a
520c782 @jeffWelling Filled in more usage examples, added mention of 'ti sync' command tha…
jeffWelling authored Sep 7, 2010
332
333 $ git push origin
334
335 to update all my remote branches with my current ones, and then I ask him to do a
336
9963b19 @jeffWelling Finished going through readme renaming to ticgit-ng
jeffWelling authored Feb 15, 2011
337 $ git checkout ticgit-ng
338 $ git pull git@github.com:jeffWelling/ticgit.git ticgit-ng
520c782 @jeffWelling Filled in more usage examples, added mention of 'ti sync' command tha…
jeffWelling authored Sep 7, 2010
339 $ git checkout master
340
9963b19 @jeffWelling Finished going through readme renaming to ticgit-ng
jeffWelling authored Feb 15, 2011
341 to pull my changes into his ticgit-ng branch and then switch back to his master branch. Now when he does `ti list` it will show the changes I made to the tickets on my system.
520c782 @jeffWelling Filled in more usage examples, added mention of 'ti sync' command tha…
jeffWelling authored Sep 7, 2010
342
343
9963b19 @jeffWelling Finished going through readme renaming to ticgit-ng
jeffWelling authored Feb 15, 2011
344 ### Incorporating other peoples changes into your ticgit-ng branch ###
520c782 @jeffWelling Filled in more usage examples, added mention of 'ti sync' command tha…
jeffWelling authored Sep 7, 2010
345
346 The process is much the same as above, except the rolls are reversed. Once you know they have published their changes and you have a URL to do a git pull from, you simply do
347
9963b19 @jeffWelling Finished going through readme renaming to ticgit-ng
jeffWelling authored Feb 15, 2011
348 $ git checkout ticgit-ng
349 $ git pull SOURCE_URL ticgit-ng
520c782 @jeffWelling Filled in more usage examples, added mention of 'ti sync' command tha…
jeffWelling authored Sep 7, 2010
350 $ git checkout master
351
9963b19 @jeffWelling Finished going through readme renaming to ticgit-ng
jeffWelling authored Feb 15, 2011
352 Replacing SOURCE_URL with the URL you were told to pull from, now you can see the changes they made, in your ticgit-ng branch. You can easily publish these changes with a `git push origin` so anyone following your work can also see these changes.
520c782 @jeffWelling Filled in more usage examples, added mention of 'ti sync' command tha…
jeffWelling authored Sep 7, 2010
353
354
53632e1 @jeffWelling Touch ups to the README
jeffWelling authored Apr 11, 2011
355 ### Next Generation collaboration ###
520c782 @jeffWelling Filled in more usage examples, added mention of 'ti sync' command tha…
jeffWelling authored Sep 7, 2010
356
6c643fc @jeffWelling Added section in README for 'ti sync' command
jeffWelling authored Feb 15, 2011
357 Changes made by [Bruno Santos](http://github.com/pheres) to add a [`ti sync`](http://github.com/jeffWelling/ticgit/commit/7388386fab4fb12c36e6eeb7d19eaa4e4b16b853) command were integrated on February 15th 2011. You can now use the `ti sync [options]` command to sync your tickets with anyone else you've added with `git remote add`. To use `ti sync`, all you need to do is first make sure you've already added the remote source with `git remote add`, and then do
573fba3 @jeffWelling Added example usage or assigning a tag
jeffWelling authored Sep 7, 2010
358
6c643fc @jeffWelling Added section in README for 'ti sync' command
jeffWelling authored Feb 15, 2011
359 $ ti sync --repo REMOTE_SOURCE
360
53632e1 @jeffWelling Touch ups to the README
jeffWelling authored Apr 11, 2011
361 if you want to pull their tickets into your ticgit-ng branch *and* push your tickets to their ticgit-ng branch, otherwise use
573fba3 @jeffWelling Added example usage or assigning a tag
jeffWelling authored Sep 7, 2010
362
6c643fc @jeffWelling Added section in README for 'ti sync' command
jeffWelling authored Feb 15, 2011
363 $ ti sync --repo REMOTE_SOURCE --no-push
364
53632e1 @jeffWelling Touch ups to the README
jeffWelling authored Apr 11, 2011
365 if you want to pull their tickets into your ticgit-ng branch *without* pushing your tickets to their branch.
6c643fc @jeffWelling Added section in README for 'ti sync' command
jeffWelling authored Feb 15, 2011
366
367 More information on using ti sync can be gleemed from reviewing the [merge specs](https://github.com/jeffWelling/ticgit/blob/deving/spec/merging_spec.rb)
af0b4ba Updated Authors header, and added Usage Examples section
jeff authored Sep 6, 2010
368
dba3fb1 @jeffWelling Added a section about TicGitWeb - shamelessly copied from schacon's wiki
jeffWelling authored Sep 6, 2010
369 ### Ticgitweb ###
370
53632e1 @jeffWelling Touch ups to the README
jeffWelling authored Apr 11, 2011
371 To run the Sinatra enabled web UI for your TicGit-ng repo, simply `cd` to your repository and run 'ticgitweb', or 'ticgitweb -p 3456' to change the port to something other than '4567', which is the Sinatra default.
dba3fb1 @jeffWelling Added a section about TicGitWeb - shamelessly copied from schacon's wiki
jeffWelling authored Sep 7, 2010
372
373 Here is what the Ticket listing looks like:
374
375 <a href="http://www.flickr.com/photos/chacon/2359042481/" title="TicGitWeb Ticket List by schacon, on Flickr"><img src="http://farm4.static.flickr.com/3289/2359042481_065867a92e.jpg" width="500" height="258" alt="TicGitWeb Ticket List" /></a>
376
377 And here is an individual ticket:
378
379 <a href="http://www.flickr.com/photos/chacon/2359042513/" title="TicGitWeb Ticket by schacon, on Flickr"><img src="http://farm4.static.flickr.com/3240/2359042513_6d4bd069d0.jpg" width="500" height="275" alt="TicGitWeb Ticket" /></a>
380
381
3733302 @jeffWelling Added a Development section to the README
jeffWelling authored Sep 6, 2010
382 ## Development ##
383
53632e1 @jeffWelling Touch ups to the README
jeffWelling authored Apr 11, 2011
384 TicGit-ng uses rspec, tests are located in the spec/ directory.
385
386 More information on the current development of TicGit-ng can be found [here](https://github.com/jeffWelling/ticgit/wiki/Development).
3733302 @jeffWelling Added a Development section to the README
jeffWelling authored Sep 7, 2010
387
388 ### Prerequisites ###
389
9963b19 @jeffWelling Finished going through readme renaming to ticgit-ng
jeffWelling authored Feb 15, 2011
390 To install the prerequisites on Debian stable for testing ticgit-ng, you will need [apt](http://jaqque.sbih.org/kplug/apt-pinning.html) [pinning](http://jeffwelling.github.com//2010/09/05/Apt-Pinning.html).
3733302 @jeffWelling Added a Development section to the README
jeffWelling authored Sep 7, 2010
391
d3e97b2 @jeffWelling Filled in prerequisites for testing on Debian stable
jeffWelling authored Sep 6, 2010
392 $ sudo aptitude -t testing install rubygems rake
ac55e96 @jeffWelling More touchups to README
jeffWelling authored Apr 11, 2011
393 $ sudo gem install yard
d3e97b2 @jeffWelling Filled in prerequisites for testing on Debian stable
jeffWelling authored Sep 7, 2010
394
395 I pull rubygems from testing to avoid a problem with gherkin creating a syntactically incorrect gemspec which makes a lot of noise whenever `gem` is called. I ran into a problem when gem was installing yard, it had a problem with the documentation but thankfully the error wasn't fatal and was only about not being able to compile the documentation which I don't use, so it continued without trouble.
3733302 @jeffWelling Added a Development section to the README
jeffWelling authored Sep 7, 2010
396
397
398 ### How To Test ###
399
9963b19 @jeffWelling Finished going through readme renaming to ticgit-ng
jeffWelling authored Feb 15, 2011
400 To test your version of ticgit-ng, go to your ticgit-ng directory and run
3733302 @jeffWelling Added a Development section to the README
jeffWelling authored Sep 7, 2010
401
ac55e96 @jeffWelling More touchups to README
jeffWelling authored Apr 11, 2011
402 rspec spec/*_spec.rb
3733302 @jeffWelling Added a Development section to the README
jeffWelling authored Sep 7, 2010
403
9963b19 @jeffWelling Finished going through readme renaming to ticgit-ng
jeffWelling authored Feb 15, 2011
404 ### How to generate a gem from your development copy of ticgit-ng ###
3733302 @jeffWelling Added a Development section to the README
jeffWelling authored Sep 7, 2010
405
9963b19 @jeffWelling Finished going through readme renaming to ticgit-ng
jeffWelling authored Feb 15, 2011
406 To create a gem from your development copy of ticgit-ng, go to your ticgit-ng directory and do
3733302 @jeffWelling Added a Development section to the README
jeffWelling authored Sep 7, 2010
407
ac55e96 @jeffWelling More touchups to README
jeffWelling authored Apr 11, 2011
408 gem build ticgit-ng.gemspec
3733302 @jeffWelling Added a Development section to the README
jeffWelling authored Sep 7, 2010
409
ac55e96 @jeffWelling More touchups to README
jeffWelling authored Apr 11, 2011
410 This will create a TicGit-ng-VERSION.gem file for you to install.
8dafd14 @jeffWelling Added Alternatives to README
jeffWelling authored Sep 7, 2010
411
aeaf3ea @jeffWelling Added note about TicGit-ng deving work and the wiki page
jeffWelling authored Feb 14, 2011
412 More information on developing TicGit-ng and collaborating with other TicGit-ng developers at [here](https://github.com/jeffWelling/ticgit/wiki/Development)
413
5f8ddc4 @jeffWelling Removed superfluous alternatives blurb
jeffWelling authored May 10, 2011
414 ### Alternatives ###
ac55e96 @jeffWelling More touchups to README
jeffWelling authored Apr 11, 2011
415
416 [Alternatives wiki page](https://github.com/jeffWelling/ticgit/wiki/Alternatives)
8dafd14 @jeffWelling Added Alternatives to README
jeffWelling authored Sep 7, 2010
417
3733302 @jeffWelling Added a Development section to the README
jeffWelling authored Sep 7, 2010
418
af0b4ba Updated Authors header, and added Usage Examples section
jeff authored Sep 6, 2010
419 ## Authors ##
420
a132ae4 Improved documentation
jeff authored Sep 6, 2010
421 Original Author:
422 Scott Chacon (schacon@gmail.com)
423
424 Current Active Maintainer:
425 Jeff Welling (jeff.welling@gmail.com)
61fc637 Readded note at the bottom about the AUTHORS file
jeff authored Sep 6, 2010
426
e627452 @jeffWelling For a detailed list of contributors, see 'git log'
jeffWelling authored Sep 25, 2010
427 For a detailed list of contributors, use `git log`.
Something went wrong with that request. Please try again.