Class: MM::Command::Help
Instance Method Summary
collapse
#card_property?, #display_value, #options, #output, #run, #user_property?, #view
Instance Method Details
#cache_options ⇒ Object
don’t want to cache options of this command
31
32
|
# File 'lib/mm/cmds/help.rb', line 31
def cache_options
end
|
#do_once ⇒ Object
19
20
21
22
23
24
|
# File 'lib/mm/cmds/help.rb', line 19
def do_once
return doc if options[:cmd].blank?
"#{MM.cmd_instance(options[:cmd]).doc}\n"
rescue Exception => e
"Unknow subcommand: #{options[:cmd]}\n#{doc}\n"
end
|
#doc ⇒ Object
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
|
# File 'lib/mm/cmds/help.rb', line 34
def doc
%{
mingle mingle, version #{MM::VERSION}
Type 'mm help <subcommand>' for help on a specific subcommand.
Queck start part 1:
* Suppose I am working on a project pet_store checked out at '~/pet_store'.
* cd ~/pet_store
* mm init http://my_login:password@mingle_server/projects/pet_store
* mm cards => list first page cards on All tab
* mm view My Work -a owner,priority => list cards on card list view named 'My Work' including property owner and priority
* mm card 102 => show name and description of the card
* mm run 'Start fix #102' => run transition 'Start fix' on card 102
* mm svnci -m "[complete fix #1 with 'fixed revision' => \#{revision}, resolution => fixed (some comment)] blabla..." => commit code and run transition script inside of []
* mm view => show view cached which is 'My Work' with property 'owner' and 'priority' by last time using view command
* mm card => show card cached number of which is 102 by last time using card command
Queck start part 2:
* export MM_NUMBER=103 => setup my working card number
* export MM_ATTRS=priority,created_by_user_id
=> setup attributes want to be displayed whenever showing a card. 'created_by_user_id' is not a custom property definition but you'll see the user name instead of id in this case, and it's same with 'Created by' column in the card list view.
* mm card
=> show the working card summarization and attributes owner and priority which are just setup.
* export MM_TRANSITION_SCRIPT_TEMPLATE_COMPLETE_FIX="complete fix #\#{number} with 'fixed revision' => \#{revision}, resolution => fixed"
=> setup a transition script template named 'complete fix'
* mm svnci -m "[complete fix] blabla..."
=> commit code and run transition script template named 'complete fix', the number variable would be found in the environment which is MM_NUMBER=103
* mm svnci -m "[complete fix] blabla..." -n 105
=> commit code and run transition script template named 'complete fix', card number is 105 instead of current working card number
Available subcommands:
help [subcommand] show help doc of subcommand
init [url] init MingleMingle working directory with Mingle REST api project base url
card [number] show card content by card number
cards [params] show cards by params, it will do nothing without params.
user [id/login] show user info by id/login
view name show cards find by view/tab name
run script run transition
svncommit(svnci) run transition execution script inside the commit message after committed code(subversion)
MingleMingle is a tool for integrating Mingle(http://studios.thoughtworks.com/) with command-line
For additional information, see http://minglemingle.rubyforge.org
Notes:
* In the command line, should use \\! instead of !.
* There would be a '.mm_pstore' file created for cache in the MingleMingle working directory.
}
end
|
#parse(argv) ⇒ Object
26
27
28
|
# File 'lib/mm/cmds/help.rb', line 26
def parse(argv)
options[:cmd] = argv.first
end
|