vclog 1.7.0 → 1.8.0
Sign up to get free protection for your applications and to get access to all the features.
- data/HISTORY.rdoc +12 -2
- data/LICENSE +197 -17
- data/README.rdoc +11 -9
- data/bin/vclog +1 -1
- data/lib/plugins/syckle/vclog.rb +12 -12
- data/lib/vclog/adapters/abstract.rb +45 -16
- data/lib/vclog/adapters/darcs.rb +6 -1
- data/lib/vclog/adapters/git.rb +42 -2
- data/lib/vclog/adapters/hg.rb +15 -1
- data/lib/vclog/adapters/svn.rb +14 -0
- data/lib/vclog/adapters.rb +0 -17
- data/lib/vclog/change.rb +4 -0
- data/lib/vclog/cli/abstract.rb +22 -13
- data/lib/vclog/cli/autotag.rb +37 -0
- data/lib/vclog/cli/bump.rb +1 -1
- data/lib/vclog/cli/changelog.rb +2 -2
- data/lib/vclog/cli/{list.rb → formats.rb} +3 -3
- data/lib/vclog/cli/help.rb +15 -10
- data/lib/vclog/cli/history.rb +3 -4
- data/lib/vclog/cli/version.rb +1 -1
- data/lib/vclog/cli.rb +24 -188
- data/lib/vclog/facets.rb +2 -0
- data/lib/vclog/history.rb +1 -1
- data/lib/vclog/history_file.rb +64 -0
- data/lib/vclog/meta/data.rb +25 -0
- data/lib/vclog/meta/package +11 -0
- data/{PROFILE → lib/vclog/meta/profile} +6 -5
- data/lib/vclog/repo.rb +150 -0
- data/lib/vclog/tag.rb +2 -2
- data/lib/vclog/templates/changelog.html.erb +23 -18
- data/lib/vclog/templates/history.html.erb +4 -3
- data/lib/vclog.rb +3 -3
- data/man/man1/vclog-autotag.1 +23 -0
- data/man/man1/vclog-bump.1 +23 -0
- data/man/man1/vclog-changelog.1 +47 -0
- data/man/man1/vclog-history.1 +44 -0
- data/man/man1/vclog-version.1 +16 -0
- data/man/man1/vclog.1 +39 -0
- data/meta/data.rb +25 -0
- data/meta/package +11 -0
- data/meta/profile +18 -0
- data/ronn/index.txt +8 -0
- data/ronn/vclog-autotag.ronn +20 -0
- data/ronn/vclog-bump.ronn +21 -0
- data/ronn/vclog-changelog.ronn +39 -0
- data/ronn/vclog-history.ronn +38 -0
- data/ronn/vclog-version.ronn +14 -0
- data/ronn/vclog.ronn +36 -0
- metadata +39 -21
- data/REQUIRE +0 -11
- data/VERSION +0 -5
- data/lib/vclog/config.rb +0 -65
data/lib/vclog/repo.rb
ADDED
@@ -0,0 +1,150 @@
|
|
1
|
+
require 'vclog/adapters'
|
2
|
+
require 'vclog/heuristics'
|
3
|
+
require 'vclog/history_file'
|
4
|
+
|
5
|
+
module VCLog
|
6
|
+
|
7
|
+
#
|
8
|
+
class Repo
|
9
|
+
# Remove some undeeded methods to make way for delegation to scm adapter.
|
10
|
+
%w{display}.each{ |name| undef_method(name) }
|
11
|
+
|
12
|
+
# File glob used to find project root directory.
|
13
|
+
ROOT_GLOB = '{.vclog/,.config/vclog/,config/vclog/,.git/,.hg/,_darcs/,README*}/'
|
14
|
+
|
15
|
+
# File glob used to find the vclog configuration directory.
|
16
|
+
CONFIG_GLOB = '{.vclog,.config/vclog,config/vclog}/'
|
17
|
+
|
18
|
+
# Project's root directory.
|
19
|
+
attr :root
|
20
|
+
|
21
|
+
#
|
22
|
+
attr :options
|
23
|
+
|
24
|
+
# Default change level.
|
25
|
+
# TODO: get from config file?
|
26
|
+
attr :level
|
27
|
+
|
28
|
+
#
|
29
|
+
def initialize(root, options={})
|
30
|
+
@root = root || lookup_root
|
31
|
+
@options = options
|
32
|
+
|
33
|
+
@config_directory = Dir[File.join(@root, CONFIG_GLOB)]
|
34
|
+
|
35
|
+
@level = (options[:level] || 0).to_i
|
36
|
+
|
37
|
+
type = read_type
|
38
|
+
raise ArgumentError, "Not a recognized version control system." unless type
|
39
|
+
|
40
|
+
@adapter = Adapters.const_get(type.capitalize).new(self)
|
41
|
+
end
|
42
|
+
|
43
|
+
# Returns instance of an Adapter subclass.
|
44
|
+
def adapter
|
45
|
+
@adapter
|
46
|
+
end
|
47
|
+
|
48
|
+
#
|
49
|
+
def config_directory
|
50
|
+
@config_directory
|
51
|
+
end
|
52
|
+
|
53
|
+
#
|
54
|
+
def force?
|
55
|
+
options[:force]
|
56
|
+
end
|
57
|
+
|
58
|
+
#
|
59
|
+
def read_type
|
60
|
+
dir = nil
|
61
|
+
Dir.chdir(root) do
|
62
|
+
dir = Dir.glob("{.svn,.git,.hg,_darcs}").first
|
63
|
+
end
|
64
|
+
dir[1..-1] if dir
|
65
|
+
end
|
66
|
+
|
67
|
+
# Find project root. This searches up from the current working
|
68
|
+
# directory for the following paths (in order):
|
69
|
+
#
|
70
|
+
# .vclog/
|
71
|
+
# .config/vclog/
|
72
|
+
# config/vclog/
|
73
|
+
# .git/|.hg/|_darcs/
|
74
|
+
# README*
|
75
|
+
#
|
76
|
+
def lookup_root(dir)
|
77
|
+
root = nil
|
78
|
+
Dir.ascend(dir || Dir.pwd) do |path|
|
79
|
+
check = Dir[ROOT_GLOB].first
|
80
|
+
if check
|
81
|
+
root = path
|
82
|
+
break
|
83
|
+
end
|
84
|
+
end
|
85
|
+
root || Dir.pwd
|
86
|
+
end
|
87
|
+
|
88
|
+
# Load heuristics script.
|
89
|
+
def heuristics
|
90
|
+
@heuristics ||= Heuristics.load(heuristics_file)
|
91
|
+
end
|
92
|
+
|
93
|
+
# Heurtistics script.
|
94
|
+
def heuristics_file
|
95
|
+
@heuristics_file ||= Dir[File.join(config_directory, 'rules.rb')].first
|
96
|
+
end
|
97
|
+
|
98
|
+
# Access to Repo's HISTORY file.
|
99
|
+
def history_file
|
100
|
+
@history_file ||= HistoryFile.new(root)
|
101
|
+
end
|
102
|
+
|
103
|
+
# Read history file and make a commit tag for any release not already
|
104
|
+
# tagged. Unless the force option is set the user will be prompted for
|
105
|
+
# each new tag.
|
106
|
+
def autotag(prefix=nil)
|
107
|
+
history_file.tags.each do |tag|
|
108
|
+
label = "#{prefix}#{tag.name}"
|
109
|
+
if not adapter.tag?(label)
|
110
|
+
chg = adapter.change_by_date(tag.date)
|
111
|
+
if chg
|
112
|
+
if force? or ask_yn(new_tag_message(label, tag) + "\nCreate tag? [yN] ")
|
113
|
+
adapter.tag(chg.rev, label, tag.date, tag.message)
|
114
|
+
end
|
115
|
+
else
|
116
|
+
puts "No commit found for #{label} #{tag.date.strftime('%Y-%m-%d')}."
|
117
|
+
end
|
118
|
+
end
|
119
|
+
end
|
120
|
+
end
|
121
|
+
|
122
|
+
# Delegate to SCM adapter.
|
123
|
+
def method_missing(s, *a, &b)
|
124
|
+
if adapter.respond_to?(s)
|
125
|
+
adapter.send(s, *a, &b)
|
126
|
+
else
|
127
|
+
super(s,*a,&b)
|
128
|
+
end
|
129
|
+
end
|
130
|
+
|
131
|
+
private
|
132
|
+
|
133
|
+
# Ask yes/no question.
|
134
|
+
def ask_yn(message)
|
135
|
+
case ask(message)
|
136
|
+
when 'y', 'Y', 'yes'
|
137
|
+
true
|
138
|
+
else
|
139
|
+
false
|
140
|
+
end
|
141
|
+
end
|
142
|
+
|
143
|
+
# Returns a String.
|
144
|
+
def new_tag_message(label, tag)
|
145
|
+
"#{label} / #{tag.date.strftime('%Y-%m-%d')}\n#{tag.message}"
|
146
|
+
end
|
147
|
+
|
148
|
+
end
|
149
|
+
|
150
|
+
end
|
data/lib/vclog/tag.rb
CHANGED
@@ -9,8 +9,8 @@ module VCLog
|
|
9
9
|
|
10
10
|
#
|
11
11
|
def initialize(name, rev, date, author, message)
|
12
|
-
self.revision = rev
|
13
12
|
self.name = name
|
13
|
+
self.revision = rev
|
14
14
|
self.date = date
|
15
15
|
self.author = author
|
16
16
|
self.message = message
|
@@ -26,7 +26,7 @@ module VCLog
|
|
26
26
|
|
27
27
|
#
|
28
28
|
def author=(author)
|
29
|
-
@author = author.strip
|
29
|
+
@author = author.to_s.strip
|
30
30
|
end
|
31
31
|
|
32
32
|
#
|
@@ -3,32 +3,37 @@
|
|
3
3
|
<title><%= title %></title>
|
4
4
|
<style>
|
5
5
|
body{font-family: sans-serif;}
|
6
|
-
h1{ }
|
6
|
+
h1{ font-weight: normal; font-size: 4em; margin: 0 0; }
|
7
7
|
h2{ color: #555; }
|
8
8
|
li{padding: 10px;}
|
9
|
-
.
|
10
|
-
.
|
11
|
-
.date{font-weight:
|
12
|
-
.author{font-weight:
|
13
|
-
.message{padding:
|
14
|
-
.revision{font-size: 0.
|
9
|
+
.main{width:800px; margin:0 auto;}
|
10
|
+
.commit{ padding: 10px 0px; }
|
11
|
+
.date{font-weight: normal; color: green; float: left; padding-right: 15px; font-size: 0.9em;}
|
12
|
+
.author{font-weight: normal; color: blue;}
|
13
|
+
.message{ padding: 5px 0; font-weight: normal; font-size: 1.1em; }
|
14
|
+
.revision{font-size: 0.7em; color: #aaa; }
|
15
15
|
</style>
|
16
16
|
<% if options.stylesheet %>
|
17
17
|
<link rel="stylesheet" href="#{options.stylesheet}" type="text/css">
|
18
18
|
<% end %>
|
19
19
|
</head>
|
20
20
|
<body>
|
21
|
-
<
|
22
|
-
<
|
23
|
-
|
24
|
-
<div class="
|
25
|
-
<
|
26
|
-
|
27
|
-
<
|
28
|
-
|
29
|
-
|
30
|
-
|
31
|
-
|
21
|
+
<div class="main">
|
22
|
+
<h1><%= title %></h1>
|
23
|
+
<h2> Timeline</h2>
|
24
|
+
<div class="changelog">
|
25
|
+
<ul>
|
26
|
+
<% changelog.changes.sort{|a,b| b.date <=> a.date}.each do |entry| %>
|
27
|
+
<li class="commit">
|
28
|
+
<div class="date"><%= entry.date %></div>
|
29
|
+
<div class="author"><%= h entry.author %></div>
|
30
|
+
<div class="type"><%= h entry.type %></div>
|
31
|
+
<div class="message"><%= h entry.message %></div>
|
32
|
+
<div class="revision">#<%= h entry.revision %></div>
|
33
|
+
</li>
|
34
|
+
<% end %>
|
35
|
+
</ul>
|
36
|
+
</div>
|
32
37
|
</div>
|
33
38
|
</body>
|
34
39
|
</html>
|
@@ -6,7 +6,7 @@
|
|
6
6
|
h1{ }
|
7
7
|
h2{ color: #555; }
|
8
8
|
li{padding: 10px;}
|
9
|
-
.
|
9
|
+
.main{width:800px; margin:0 auto;}
|
10
10
|
.title{font-size: 64px;}
|
11
11
|
.date{font-weight: bold; color: green; float: left; padding-right: 15px;}
|
12
12
|
.author{font-weight: bold; color: blue;}
|
@@ -18,9 +18,9 @@
|
|
18
18
|
<% end %>
|
19
19
|
</head>
|
20
20
|
<body>
|
21
|
-
<div class="
|
21
|
+
<div class="main">
|
22
22
|
<div class="title"><%= title %></div>
|
23
|
-
|
23
|
+
<div class="history">
|
24
24
|
<% history.releases.sort.each do |release| %>
|
25
25
|
<% tag = release.tag %>
|
26
26
|
|
@@ -47,6 +47,7 @@
|
|
47
47
|
<% end %>
|
48
48
|
<% end %>
|
49
49
|
</div>
|
50
|
+
</div>
|
50
51
|
</body>
|
51
52
|
</html>
|
52
53
|
|
data/lib/vclog.rb
CHANGED
@@ -0,0 +1,23 @@
|
|
1
|
+
.\" generated with Ronn/v0.7.3
|
2
|
+
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
3
|
+
.
|
4
|
+
.TH "VCLOG\-AUTOTAG" "1" "November 2010" "RubyWorks" "VCLog"
|
5
|
+
.
|
6
|
+
.SH "NAME"
|
7
|
+
\fBvclog\-autotag\fR \- tag history entries
|
8
|
+
.
|
9
|
+
.SH "SYNOPSIS"
|
10
|
+
\fBvclog autotag\fR
|
11
|
+
.
|
12
|
+
.SH "DESCRIPTION"
|
13
|
+
Ensure all HISTORY file entries have corresponding commit tags in the version control system\.
|
14
|
+
.
|
15
|
+
.SH "OPTIONS"
|
16
|
+
.
|
17
|
+
.IP "\(bu" 4
|
18
|
+
\fB\-\-force\fR, \fB\-f\fR Creatie tags without asking for confirmation\.
|
19
|
+
.
|
20
|
+
.IP "" 0
|
21
|
+
.
|
22
|
+
.SH "SEE ALSO"
|
23
|
+
vclog(1)
|
@@ -0,0 +1,23 @@
|
|
1
|
+
.\" generated with Ronn/v0.7.3
|
2
|
+
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
3
|
+
.
|
4
|
+
.TH "VCLOG\-BUMP" "1" "November 2010" "RubyWorks" "VCLog"
|
5
|
+
.
|
6
|
+
.SH "NAME"
|
7
|
+
\fBvclog\-bump\fR \- suggest next version
|
8
|
+
.
|
9
|
+
.SH "SYNOPSIS"
|
10
|
+
\fBvclog bump\fR
|
11
|
+
.
|
12
|
+
.SH "DESCRIPTION"
|
13
|
+
Display the next most suitable version number, based on the current version number\. The bump command considers the commit levels in determining if the next version should be a major or minor bump\.
|
14
|
+
.
|
15
|
+
.SH "OPTIONS"
|
16
|
+
.
|
17
|
+
.IP "\(bu" 4
|
18
|
+
\fB\-\-version\fR, \fB\-v NUM\fR Assume this version number is current\.
|
19
|
+
.
|
20
|
+
.IP "" 0
|
21
|
+
.
|
22
|
+
.SH "SEE ALSO"
|
23
|
+
vclog(1)
|
@@ -0,0 +1,47 @@
|
|
1
|
+
.\" generated with Ronn/v0.7.3
|
2
|
+
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
3
|
+
.
|
4
|
+
.TH "VCLOG\-CHANGELOG" "1" "November 2010" "RubyWorks" "VCLog"
|
5
|
+
.
|
6
|
+
.SH "NAME"
|
7
|
+
\fBvclog\-changelog\fR \- change log
|
8
|
+
.
|
9
|
+
.SH "SYNOPSIS"
|
10
|
+
\fBvclog\fR
|
11
|
+
.
|
12
|
+
.br
|
13
|
+
\fBvclog log\fR
|
14
|
+
.
|
15
|
+
.br
|
16
|
+
\fBvclog changelog\fR
|
17
|
+
.
|
18
|
+
.SH "DESCRIPTION"
|
19
|
+
Produce a Change Log\.
|
20
|
+
.
|
21
|
+
.SH "OPTIONS"
|
22
|
+
.
|
23
|
+
.IP "\(bu" 4
|
24
|
+
\fB\-\-version\fR, \fB\-v <VERSION>\fR Set current version number\.
|
25
|
+
.
|
26
|
+
.IP "\(bu" 4
|
27
|
+
\fB\-f\fR, \fB\-\-format <FORMAT>\fR Output format\.
|
28
|
+
.
|
29
|
+
.IP "\(bu" 4
|
30
|
+
\fB\-\-style <URI>\fR Provide a stylesheet URI (css or xsl) for HTML or XML format\.
|
31
|
+
.
|
32
|
+
.IP "\(bu" 4
|
33
|
+
\fB\-t\fR, \fB\-\-title TITLE\fR Document title\.
|
34
|
+
.
|
35
|
+
.IP "\(bu" 4
|
36
|
+
\fB\-s\fR, \fB\-\-summarize\fR Produce summary output\.
|
37
|
+
.
|
38
|
+
.IP "\(bu" 4
|
39
|
+
\fB\-\-id\fR Include revision id in output\.
|
40
|
+
.
|
41
|
+
.IP "\(bu" 4
|
42
|
+
\fB\-l\fR, \fB\-\-level <NUMBER>\fR Lowest level of commit to display [0]\.
|
43
|
+
.
|
44
|
+
.IP "" 0
|
45
|
+
.
|
46
|
+
.SH "SEE ALSO"
|
47
|
+
vclog(1), vclog\-history(1)
|
@@ -0,0 +1,44 @@
|
|
1
|
+
.\" generated with Ronn/v0.7.3
|
2
|
+
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
3
|
+
.
|
4
|
+
.TH "VCLOG\-HISTORY" "1" "November 2010" "RubyWorks" "VCLog"
|
5
|
+
.
|
6
|
+
.SH "NAME"
|
7
|
+
\fBvclog\-history\fR \- release history
|
8
|
+
.
|
9
|
+
.SH "SYNOPSIS"
|
10
|
+
\fBvclog history\fR
|
11
|
+
.
|
12
|
+
.br
|
13
|
+
\fBvclog release\fR
|
14
|
+
.
|
15
|
+
.SH "DESCRIPTION"
|
16
|
+
Produce a Release History\.
|
17
|
+
.
|
18
|
+
.SH "OPTIONS"
|
19
|
+
.
|
20
|
+
.IP "\(bu" 4
|
21
|
+
\fB\-\-version\fR, \fB\-v <VERSION>\fR Set current version number\.
|
22
|
+
.
|
23
|
+
.IP "\(bu" 4
|
24
|
+
\fB\-f\fR, \fB\-\-format <FORMAT>\fR Output format\.
|
25
|
+
.
|
26
|
+
.IP "\(bu" 4
|
27
|
+
\fB\-\-style <URI>\fR Provide a stylesheet URI (css or xsl) for HTML or XML format\.
|
28
|
+
.
|
29
|
+
.IP "\(bu" 4
|
30
|
+
\fB\-t\fR, \fB\-\-title TITLE\fR Document title\.
|
31
|
+
.
|
32
|
+
.IP "\(bu" 4
|
33
|
+
\fB\-s\fR, \fB\-\-summarize\fR Produce summary output\.
|
34
|
+
.
|
35
|
+
.IP "\(bu" 4
|
36
|
+
\fB\-\-id\fR Include revision id in output\.
|
37
|
+
.
|
38
|
+
.IP "\(bu" 4
|
39
|
+
\fB\-l\fR, \fB\-\-level <NUMBER>\fR Lowest level of commit to display [0]\.
|
40
|
+
.
|
41
|
+
.IP "" 0
|
42
|
+
.
|
43
|
+
.SH "SEE ALSO"
|
44
|
+
vclog(1)
|
@@ -0,0 +1,16 @@
|
|
1
|
+
.\" generated with Ronn/v0.7.3
|
2
|
+
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
3
|
+
.
|
4
|
+
.TH "VCLOG\-VERSION" "1" "November 2010" "RubyWorks" "VCLog"
|
5
|
+
.
|
6
|
+
.SH "NAME"
|
7
|
+
\fBvclog\-version\fR \- display current version
|
8
|
+
.
|
9
|
+
.SH "SYNOPSIS"
|
10
|
+
\fBvclog version\fR
|
11
|
+
.
|
12
|
+
.SH "DESCRIPTION"
|
13
|
+
Display current version number according to source control system\.
|
14
|
+
.
|
15
|
+
.SH "SEE ALSO"
|
16
|
+
vclog(1)
|
data/man/man1/vclog.1
ADDED
@@ -0,0 +1,39 @@
|
|
1
|
+
.\" generated with Ronn/v0.7.3
|
2
|
+
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
3
|
+
.
|
4
|
+
.TH "VCLOG" "1" "November 2010" "RubyWorks" "VCLog"
|
5
|
+
.
|
6
|
+
.SH "NAME"
|
7
|
+
\fBvclog\fR \- version control logging utility
|
8
|
+
.
|
9
|
+
.SH "SYNOPSIS"
|
10
|
+
\fBvclog [command]\fR
|
11
|
+
.
|
12
|
+
.SH "DESCRIPTION"
|
13
|
+
VCLog is a versitle cross\-VCS/SCM changelog generator\. It currently supports Git, Hg and (limited) Subversion\.
|
14
|
+
.
|
15
|
+
.SH "COMMANDS"
|
16
|
+
VCLog provides a number of useful functions:
|
17
|
+
.
|
18
|
+
.IP "\(bu" 4
|
19
|
+
\fBchangelog\fR Produce a Change Log\.
|
20
|
+
.
|
21
|
+
.IP "\(bu" 4
|
22
|
+
\fBhistory\fR Produce a Release History\.
|
23
|
+
.
|
24
|
+
.IP "\(bu" 4
|
25
|
+
\fBversion\fR Show current tag version\.
|
26
|
+
.
|
27
|
+
.IP "\(bu" 4
|
28
|
+
\fBbump\fR Suggest next tag version\.
|
29
|
+
.
|
30
|
+
.IP "\(bu" 4
|
31
|
+
\fBautotag\fR Ensure a tag exists for each History entry\.
|
32
|
+
.
|
33
|
+
.IP "" 0
|
34
|
+
.
|
35
|
+
.P
|
36
|
+
Both \fBchangelog\fR and \fBhistory\fR can be produced in a variety of formats\.
|
37
|
+
.
|
38
|
+
.SH "SEE ALSO"
|
39
|
+
vclog\-changelog(1), vclog\-history(1), vclog\-version(1), vclog\-bump(1), vclog\-autotag(1)
|
data/meta/data.rb
ADDED
@@ -0,0 +1,25 @@
|
|
1
|
+
module VCLog
|
2
|
+
|
3
|
+
def self.package
|
4
|
+
@package ||= (
|
5
|
+
require 'yaml'
|
6
|
+
YAML.load(File.new(File.dirname(__FILE__) + '/package'))
|
7
|
+
)
|
8
|
+
end
|
9
|
+
|
10
|
+
def self.profile
|
11
|
+
@profile ||= (
|
12
|
+
require 'yaml'
|
13
|
+
YAML.load(File.new(File.dirname(__FILE__) + '/profile'))
|
14
|
+
)
|
15
|
+
end
|
16
|
+
|
17
|
+
def self.const_missing(name)
|
18
|
+
key = name.to_s.downcase
|
19
|
+
package[key] || profile[key] || super(name)
|
20
|
+
end
|
21
|
+
|
22
|
+
# Prime version.
|
23
|
+
VERSION = package['version']
|
24
|
+
end
|
25
|
+
|
data/meta/package
ADDED
data/meta/profile
ADDED
@@ -0,0 +1,18 @@
|
|
1
|
+
---
|
2
|
+
title : VCLog
|
3
|
+
suite : rubyworks
|
4
|
+
summary : Cross-VCS/SCM ChangeLog Generator
|
5
|
+
license : Apache 2.0
|
6
|
+
contact : trans <transfire@gmail.com>
|
7
|
+
created : 2006-05-09
|
8
|
+
authors : Thomas Sawyer
|
9
|
+
|
10
|
+
description:
|
11
|
+
VCLog is a cross-VCS/SCM ChangeLog generator.
|
12
|
+
|
13
|
+
resources:
|
14
|
+
home: http://rubyworks.github.com/vclog
|
15
|
+
code: http://github.com/rubyworks/vclog
|
16
|
+
repo: git://github.com/proutils/vclog.git
|
17
|
+
|
18
|
+
copyright: Copyright (c) 2009 Thomas Sawyer
|
data/ronn/index.txt
ADDED
@@ -0,0 +1,20 @@
|
|
1
|
+
vclog-autotag(1) - tag history entries
|
2
|
+
======================================
|
3
|
+
|
4
|
+
## SYNOPSIS
|
5
|
+
|
6
|
+
`vclog autotag`
|
7
|
+
|
8
|
+
## DESCRIPTION
|
9
|
+
|
10
|
+
Ensure all HISTORY file entries have corresponding commit tags in
|
11
|
+
the version control system.
|
12
|
+
|
13
|
+
## OPTIONS
|
14
|
+
|
15
|
+
* `--force`, `-f`
|
16
|
+
Creatie tags without asking for confirmation.
|
17
|
+
|
18
|
+
## SEE ALSO
|
19
|
+
|
20
|
+
vclog(1)
|
@@ -0,0 +1,21 @@
|
|
1
|
+
vclog-bump(1) - suggest next version
|
2
|
+
====================================
|
3
|
+
|
4
|
+
## SYNOPSIS
|
5
|
+
|
6
|
+
`vclog bump`
|
7
|
+
|
8
|
+
## DESCRIPTION
|
9
|
+
|
10
|
+
Display the next most suitable version number, based on the current
|
11
|
+
version number. The bump command considers the commit levels in
|
12
|
+
determining if the next version should be a major or minor bump.
|
13
|
+
|
14
|
+
## OPTIONS
|
15
|
+
|
16
|
+
* `--version`, `-v NUM`
|
17
|
+
Assume this version number is current.
|
18
|
+
|
19
|
+
## SEE ALSO
|
20
|
+
|
21
|
+
vclog(1)
|
@@ -0,0 +1,39 @@
|
|
1
|
+
vclog-changelog(1) - change log
|
2
|
+
===============================
|
3
|
+
|
4
|
+
## SYNOPSIS
|
5
|
+
|
6
|
+
`vclog`<br>
|
7
|
+
`vclog log`<br>
|
8
|
+
`vclog changelog`
|
9
|
+
|
10
|
+
## DESCRIPTION
|
11
|
+
|
12
|
+
Produce a Change Log.
|
13
|
+
|
14
|
+
## OPTIONS
|
15
|
+
|
16
|
+
* `--version`, `-v <VERSION>`
|
17
|
+
Set current version number.
|
18
|
+
|
19
|
+
* `-f`, `--format <FORMAT>`
|
20
|
+
Output format.
|
21
|
+
|
22
|
+
* `--style <URI>`
|
23
|
+
Provide a stylesheet URI (css or xsl) for HTML or XML format.
|
24
|
+
|
25
|
+
* `-t`, `--title TITLE`
|
26
|
+
Document title.
|
27
|
+
|
28
|
+
* `-s`, `--summarize`
|
29
|
+
Produce summary output.
|
30
|
+
|
31
|
+
* `--id`
|
32
|
+
Include revision id in output.
|
33
|
+
|
34
|
+
* `-l`, `--level <NUMBER>`
|
35
|
+
Lowest level of commit to display [0].
|
36
|
+
|
37
|
+
## SEE ALSO
|
38
|
+
|
39
|
+
vclog(1), vclog-history(1)
|
@@ -0,0 +1,38 @@
|
|
1
|
+
vclog-history(1) - release history
|
2
|
+
==================================
|
3
|
+
|
4
|
+
## SYNOPSIS
|
5
|
+
|
6
|
+
`vclog history`<br>
|
7
|
+
`vclog release`
|
8
|
+
|
9
|
+
## DESCRIPTION
|
10
|
+
|
11
|
+
Produce a Release History.
|
12
|
+
|
13
|
+
## OPTIONS
|
14
|
+
|
15
|
+
* `--version`, `-v <VERSION>`
|
16
|
+
Set current version number.
|
17
|
+
|
18
|
+
* `-f`, `--format <FORMAT>`
|
19
|
+
Output format.
|
20
|
+
|
21
|
+
* `--style <URI>`
|
22
|
+
Provide a stylesheet URI (css or xsl) for HTML or XML format.
|
23
|
+
|
24
|
+
* `-t`, `--title TITLE`
|
25
|
+
Document title.
|
26
|
+
|
27
|
+
* `-s`, `--summarize`
|
28
|
+
Produce summary output.
|
29
|
+
|
30
|
+
* `--id`
|
31
|
+
Include revision id in output.
|
32
|
+
|
33
|
+
* `-l`, `--level <NUMBER>`
|
34
|
+
Lowest level of commit to display [0].
|
35
|
+
|
36
|
+
## SEE ALSO
|
37
|
+
|
38
|
+
vclog(1)
|