-
Notifications
You must be signed in to change notification settings - Fork 1
/
version.html
237 lines (181 loc) · 6.71 KB
/
version.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
<title>version</title>
<style type="text/css">
html { font-size: 100%; overflow-y: scroll; -webkit-text-size-adjust: 100%; -ms-text-size-adjust: 100%; }
body{
color:#444;
font-family:Georgia, Palatino, 'Palatino Linotype', Times, 'Times New Roman',
"Hiragino Sans GB", "STXihei", "微软雅黑", serif;
font-size:12px;
line-height:1.5em;
background:#fefefe;
width: 45em;
margin: 10px auto;
padding: 1em;
outline: 1300px solid #FAFAFA;
}
a{ color: #0645ad; text-decoration:none;}
a:visited{ color: #0b0080; }
a:hover{ color: #06e; }
a:active{ color:#faa700; }
a:focus{ outline: thin dotted; }
a:hover, a:active{ outline: 0; }
span.backtick {
border:1px solid #EAEAEA;
border-radius:3px;
background:#F8F8F8;
padding:0 3px 0 3px;
}
::-moz-selection{background:rgba(255,255,0,0.3);color:#000}
::selection{background:rgba(255,255,0,0.3);color:#000}
a::-moz-selection{background:rgba(255,255,0,0.3);color:#0645ad}
a::selection{background:rgba(255,255,0,0.3);color:#0645ad}
p{
margin:1em 0;
}
img{
max-width:100%;
}
h1,h2,h3,h4,h5,h6{
font-weight:normal;
color:#111;
line-height:1em;
}
h4,h5,h6{ font-weight: bold; }
h1{ font-size:2.5em; }
h2{ font-size:2em; border-bottom:1px solid silver; padding-bottom: 5px; }
h3{ font-size:1.5em; }
h4{ font-size:1.2em; }
h5{ font-size:1em; }
h6{ font-size:0.9em; }
blockquote{
color:#666666;
margin:0;
padding-left: 3em;
border-left: 0.5em #EEE solid;
}
hr { display: block; height: 2px; border: 0; border-top: 1px solid #aaa;border-bottom: 1px solid #eee; margin: 1em 0; padding: 0; }
pre , code, kbd, samp {
color: #000;
font-family: monospace;
font-size: 0.88em;
border-radius:3px;
background-color: #F8F8F8;
border: 1px solid #CCC;
}
pre { white-space: pre; white-space: pre-wrap; word-wrap: break-word; padding: 5px 12px;}
pre code { border: 0px !important; padding: 0;}
code { padding: 0 3px 0 3px; }
b, strong { font-weight: bold; }
dfn { font-style: italic; }
ins { background: #ff9; color: #000; text-decoration: none; }
mark { background: #ff0; color: #000; font-style: italic; font-weight: bold; }
sub, sup { font-size: 75%; line-height: 0; position: relative; vertical-align: baseline; }
sup { top: -0.5em; }
sub { bottom: -0.25em; }
ul, ol { margin: 1em 0; padding: 0 0 0 2em; }
li p:last-child { margin:0 }
dd { margin: 0 0 0 2em; }
img { border: 0; -ms-interpolation-mode: bicubic; vertical-align: middle; }
table {
display:block;
overflow:auto;
width:100%;
border-collapse: collapse;
border-spacing: 0;
padding: 0;
}
table th { font-weight:700; }
table th, table td { border: 1px solid #ddd; padding: 6px 13px; vertical-align: top;}
table tr { background-color: #fff; border-top: 1px solid #ccc; }
table tr:nth-child(2n) { background-color: #f8f8f8; }
@media only screen and (min-width: 480px) {
body{font-size:14px;}
}
@media only screen and (min-width: 768px) {
body{font-size:16px;}
}
@media print {
* { background: transparent !important; color: black !important; filter:none !important; -ms-filter: none !important; }
body{font-size:12pt; max-width:100%; outline:none;}
a, a:visited { text-decoration: underline; }
hr { height: 1px; border:0; border-bottom:1px solid black; }
a[href]:after { content: " (" attr(href) ")"; }
abbr[title]:after { content: " (" attr(title) ")"; }
.ir a:after, a[href^="javascript:"]:after, a[href^="#"]:after { content: ""; }
pre, blockquote { border: 1px solid #999; padding-right: 1em; page-break-inside: avoid; }
tr, img { page-break-inside: avoid; }
img { max-width: 100% !important; }
@page :left { margin: 15mm 20mm 15mm 10mm; }
@page :right { margin: 15mm 10mm 15mm 20mm; }
p, h2, h3 { orphans: 3; widows: 3; }
h2, h3 { page-break-after: avoid; }
}
</style>
</head>
<body>
<h1 id="toc_0">Version Control</h1>
<p>Increments version number based on git tags.</p>
<h2 id="toc_1">Git Project Setup</h2>
<table>
<thead>
<tr>
<th>Command</th>
<th>Instructions</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>cp version.py /usr/local/bin/version</code></td>
<td>Install the script on the developer and build machines.</td>
</tr>
<tr>
<td><code>git init && version init</code></td>
<td>Init the repo and create the first tag.</td>
</tr>
<tr>
<td><code>git checkout -b develop</code></td>
<td>Start commiting code on the develop branch.</td>
</tr>
<tr>
<td><code>version release</code></td>
<td>Create a new release from the develop to the master branch, pushing the changes to origin.</td>
</tr>
</tbody>
</table>
<h2 id="toc_2">Workflow</h2>
<p><img src="version-flow.png" alt="version workflow git graph"></p>
<p>The initial version must be provided in the repository <em>master</em> branch for the current version to be extracted. Its format defines how the next versions are calculated:</p>
<ul>
<li>2 digits (<code>major.minor</code>) will produce a 3 digit version next</li>
<li>3 digits (<code>major.minor.patch</code>) will continue the 3 digit scheme</li>
<li>4 digits (<code>major.minor.patch.build</code>) will use the last field to keep a global counter of releases</li>
</ul>
<p><code>version init</code> will setup this for you using the 4 digits format by default.</p>
<p>Using the <code>release</code> command will merge the current <em>develop</em> into <em>master</em>, tagging it with the next patch version number and merging that tag back to <em>develop</em>.</p>
<p>The <code>hotfix-start</code> command creates a temporary branch from <em>master</em> where commits can be made and <code>hotfix-finish</code> will merge those changes back to <em>master</em> and tag it with the next patch version number. Hotfix commits can be manually merged into <em>develop</em> if needed.</p>
<h2 id="toc_3">Jenkins Configuration</h2>
<h3 id="toc_4">Dependencies</h3>
<ul>
<li><a href="https://wiki.jenkins-ci.org/display/JENKINS/Git+Plugin">Git Plugin</a></li>
<li><a href="https://wiki.jenkins-ci.org/display/JENKINS/EnvInject+Plugin">EnvInject Plugin</a></li>
</ul>
<h3 id="toc_5">Source code management:</h3>
<p>Configure your git repository URL and branch to build, then click advanced and set:</p>
<ul>
<li>Skip internal tag: true</li>
<li>Use shallow clone: false</li>
</ul>
<p>Otherwise you'll get the wrong version number.</p>
<h3 id="toc_6">Build steps:</h3>
<ul>
<li>Execute shell: <br /><code>echo CURRENT_VERSION=$(python "/usr/local/bin/version" show) > envvars</code></li>
<li>Inject environment variables - Properties File Path: <code>envvars</code></li>
</ul>
<p>The <code>CURRENT_VERSION</code> variable will then be available to use in your build environment, containing the version obtained from the most recent git tag.</p>
</body>
</html>