-
Notifications
You must be signed in to change notification settings - Fork 651
/
Copy pathindex.html
733 lines (706 loc) · 26.1 KB
/
index.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
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
<!doctype html>
<html>
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta name="description" />
<meta
name="keywords"
content="static content generator,static site generator,static site,HTML,web development,.NET,C#,Razor,Markdown,YAML"
/>
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<link
rel="shortcut icon"
href="/assets/img/favicon.ico"
type="image/x-icon"
/>
<link rel="icon" href="/assets/img/favicon.ico" type="image/x-icon" />
<title>GitVersion - Documentation</title>
<link href="/assets/css/highlight.css" rel="stylesheet" />
<link href="/assets/css/bootstrap/bootstrap.css" rel="stylesheet" />
<link href="/assets/css/adminlte/AdminLTE.css" rel="stylesheet" />
<link href="/assets/css/theme/theme.css" rel="stylesheet" />
<link
href="//fonts.googleapis.com/css?family=Roboto+Mono:400,700|Roboto:400,400i,700,700i"
rel="stylesheet"
/>
<link
href="/assets/css/font-awesome.min.css"
rel="stylesheet"
type="text/css"
/>
<link href="/assets/css/override.css" rel="stylesheet" />
<script src="/assets/js/jquery-2.2.3.min.js"></script>
<script src="/assets/js/bootstrap.min.js"></script>
<script src="/assets/js/app.min.js"></script>
<script src="/assets/js/highlight.pack.js"></script>
<script src="/assets/js/jquery.slimscroll.min.js"></script>
<script src="/assets/js/jquery.sticky-kit.min.js"></script>
<script src="/assets/js/mermaid.min.js"></script>
<script src="/assets/js/svg-pan-zoom.min.js"></script>
<meta name="google" content="notranslate" />
<meta http-equiv="Content-Language" content="en" />
<meta
name="google-site-verification"
content="46g_yrsDyk5YTGoXb2ii9BjmTJ2QAEsacqn6wqiAiII"
/>
<meta
property="og:image"
content="https://github.com/GitTools/graphics/raw/master/GitVersion/banner-1280x640.png"
/>
<meta property="og:site_name" content="GitVersion" />
<meta property="og:type" content="object" />
<meta property="og:title" content="GitVersion" />
<meta property="og:url" content="https://gitversion.net/" />
<meta
property="og:description"
content="From git log to SemVer in no time"
/>
<link rel="icon" href="/assets/img/icon.png" type="image/png" />
<link rel="icon" href="/assets/img/icon.svg" type="image/svg" />
<link rel="apple-touch-icon" href="/assets/img/icon.png" type="image/png" />
<link rel="apple-touch-icon" href="/assets/img/icon.svg" type="image/svg" />
</head>
<body class="hold-transition wyam layout-boxed">
<div class="top-banner"></div>
<div class="wrapper with-container">
<!-- Header -->
<header class="main-header">
<a href="/" class="logo">
<span>GitVersion</span>
</a>
<nav class="navbar navbar-static-top" role="navigation">
<!-- Sidebar toggle button-->
<a
href="#"
class="sidebar-toggle visible-xs-block"
data-toggle="offcanvas"
role="button"
>
<span class="sr-only">Toggle side menu</span>
<i class="fa fa-chevron-circle-right"></i>
</a>
<div class="navbar-header">
<button
type="button"
class="navbar-toggle collapsed"
data-toggle="collapse"
data-target="#navbar-collapse"
>
<span class="sr-only">Toggle side menu</span>
<i class="fa fa-chevron-circle-down"></i>
</button>
</div>
<!-- Collect the nav links, forms, and other content for toggling -->
<div class="collapse navbar-collapse pull-left" id="navbar-collapse">
<ul class="nav navbar-nav">
<li class="active"><a href="/docs">Documentation</a></li>
<li><a href="/api">API</a></li>
<li>
<a href="/5.12.0/docs"><i></i> 5.12.0</a>
</li>
</ul>
</div>
<!-- /.navbar-collapse -->
<!-- Navbar Right Menu -->
</nav>
</header>
<!-- Left side column. contains the logo and sidebar -->
<aside class="main-sidebar">
<section
class="infobar"
data-spy="affix"
data-offset-top="60"
data-offset-bottom="200"
>
<div>
<p>
<a
href="https://github.com/gittools/GitVersion/tree/main/docs/input/docs/index.cshtml"
><i class="fa fa-pencil-square" aria-hidden="true"></i> Edit
Content</a
>
</p>
</div>
<div id="infobar-headings"></div>
</section>
<section class="sidebar">
<ul class="sidebar-menu">
<li class="treeview">
<a href="/docs/usage">Usage</a> <a href="#" class="expand"></a>
<ul class="treeview-menu">
<li><a href="/docs/usage/ci">Continuous Integration</a></li>
<li class="treeview">
<a href="/docs/usage/cli">Command Line</a>
<a href="#" class="expand"></a>
<ul class="treeview-menu">
<li>
<a href="/docs/usage/cli/installation">Installation</a>
</li>
<li><a href="/docs/usage/cli/arguments">Arguments</a></li>
<li><a href="/docs/usage/cli/output">Output</a></li>
<li>
<a href="/docs/usage/cli/assembly-patch"
>Assembly Patching</a
>
</li>
</ul>
</li>
<li><a href="/docs/usage/msbuild">MSBuild Task</a></li>
<li><a href="/docs/usage/library">Library</a></li>
<li><a href="/docs/usage/docker">Docker</a></li>
</ul>
</li>
<li class="treeview">
<a href="/docs/reference">Reference</a>
<a href="#" class="expand"></a>
<ul class="treeview-menu">
<li>
<a href="/docs/reference/configuration">Configuration</a>
</li>
<li>
<a href="/docs/reference/variables">Version Variables</a>
</li>
<li><a href="/docs/reference/requirements">Requirements</a></li>
<li>
<a href="/docs/reference/version-increments"
>Version Incrementing</a
>
</li>
<li>
<a href="/docs/reference/version-sources">Version Sources</a>
</li>
<li class="treeview">
<a href="/docs/reference/modes">Versioning Modes</a>
<a href="#" class="expand"></a>
<ul class="treeview-menu">
<li>
<a href="/docs/reference/modes/manual-deployment"
>Manual Deployment</a
>
</li>
<li>
<a href="/docs/reference/modes/continuous-delivery"
>Continuous Delivery</a
>
</li>
<li>
<a href="/docs/reference/modes/continuous-deployment"
>Continuous Deployment</a
>
</li>
</ul>
</li>
<li class="treeview">
<a href="/docs/reference/build-servers">Build Servers</a>
<a href="#" class="expand"></a>
<ul class="treeview-menu">
<li>
<a href="/docs/reference/build-servers/appveyor"
>AppVeyor</a
>
</li>
<li>
<a href="/docs/reference/build-servers/azure-devops"
>Azure DevOps</a
>
</li>
<li>
<a href="/docs/reference/build-servers/bamboo">Bamboo</a>
</li>
<li>
<a
href="/docs/reference/build-servers/bitbucket-pipelines"
>BitBucket Pipelines</a
>
</li>
<li>
<a href="/docs/reference/build-servers/buildkite"
>Buildkite</a
>
</li>
<li>
<a href="/docs/reference/build-servers/continua"
>Continua CI</a
>
</li>
<li>
<a href="/docs/reference/build-servers/github-actions"
>GitHub Actions</a
>
</li>
<li>
<a href="/docs/reference/build-servers/gitlab"
>GitLab CI</a
>
</li>
<li>
<a href="/docs/reference/build-servers/jenkins"
>Jenkins</a
>
</li>
<li>
<a href="/docs/reference/build-servers/myget">MyGet</a>
</li>
<li>
<a href="/docs/reference/build-servers/octopus-deploy"
>Octopus Deploy</a
>
</li>
<li>
<a href="/docs/reference/build-servers/teamcity"
>TeamCity</a
>
</li>
</ul>
</li>
</ul>
</li>
<li class="treeview">
<a href="/docs/learn">Learn</a> <a href="#" class="expand"></a>
<ul class="treeview-menu">
<li><a href="/docs/learn/how-it-works">How it works</a></li>
<li>
<a href="/docs/learn/intro-to-semver">Intro to SemVer</a>
</li>
<li>
<a href="/docs/learn/dynamic-repositories"
>Dynamic Repositories</a
>
</li>
<li><a href="/docs/learn/git-setup">Git Setup</a></li>
<li><a href="/docs/learn/faq">FAQ</a></li>
<li><a href="/docs/learn/why">Why use GitVersion?</a></li>
<li><a href="/docs/learn/who">Who is using GitVersion</a></li>
<li><a href="/docs/learn/credits">Credits</a></li>
<li class="treeview">
<a href="/docs/learn/branching-strategies"
>Branching Strategies</a
>
<a href="#" class="expand"></a>
<ul class="treeview-menu">
<li>
<a href="/docs/learn/branching-strategies/overview"
>Overview</a
>
</li>
<li class="treeview">
<a href="/docs/learn/branching-strategies/gitflow"
>Git Flow</a
>
<a href="#" class="expand"></a>
<ul class="treeview-menu">
<li>
<a
href="/docs/learn/branching-strategies/gitflow/examples"
>GitFlow Examples</a
>
</li>
<li>
<a
href="/docs/learn/branching-strategies/gitflow/converting-to-gitflow"
>Converting to GitFlow</a
>
</li>
</ul>
</li>
<li class="treeview">
<a href="/docs/learn/branching-strategies/githubflow"
>GitHub Flow</a
>
<a href="#" class="expand"></a>
<ul class="treeview-menu">
<li>
<a
href="/docs/learn/branching-strategies/githubflow/examples"
>GitHubFlow Examples</a
>
</li>
</ul>
</li>
<li>
<a
href="/docs/learn/branching-strategies/contribute-examples"
>Contribute Examples</a
>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</section>
</aside>
<!-- Content Wrapper. Contains page content -->
<div class="content-wrapper">
<section class="content-header">
<h1>Documentation</h1>
</section>
<section class="content">
<p>
GitVersion is a tool that generates a
<a href="https://semver.org/">Semantic Version number</a> based on
your Git history. The version number generated from GitVersion can
then be used for various different purposes, such as:
</p>
<ol>
<li>
Stamping a version number on artifacts (packages) produced during
build.
</li>
<li>
Exposing the version number to the build server to version the
build itself.
</li>
<li>
Patching <code>AssemblyInfo.cs</code> (and similar) files with the
version number during the build, so the version number is embedded
within the compiled binaries themselves.
</li>
</ol>
<h2>Consuming GitVersion</h2>
<p>
There are four different ways to consume GitVersion itself. You can
find each of these options below.
</p>
<div class="card-container">
<div class="card">
<div class="card-header">
<img src="/assets/img/repeat.svg" alt="" aria-hidden="true" />
<h5>Continuous Integration</h5>
</div>
<div class="card-body">
<p class="card-text">
GitVersion can be used in a Continuous Server pipeline to
generate a version number that both labels the build itself
and makes the different version variables available to the
rest of the build pipeline.
</p>
<a href="/docs/usage/ci" class="btn btn-primary">
Continuous Integration
</a>
</div>
</div>
<div class="card">
<div class="card-header">
<img src="/assets/img/terminal.svg" alt="" aria-hidden="true" />
<h5>Command Line</h5>
</div>
<div class="card-body">
<p class="card-text">
The Command Line gives most flexibility by allowing the
execution of GitVersion to be customized
</p>
<a href="/docs/usage/cli/index" class="btn btn-primary">
Command Line
</a>
</div>
</div>
<div class="card">
<div class="card-header">
<img src="/assets/img/collect.svg" alt="" aria-hidden="true" />
<h5>MSBuild Task</h5>
</div>
<div class="card-body">
<p class="card-text">
Just install with NuGet and GitVersion will automatically
generate assembly version information that is compiled into
the resulting artifact.
</p>
<a href="/docs/usage/msbuild" class="btn btn-primary">
MSBuild Task
</a>
</div>
</div>
<div class="card">
<div class="card-header">
<img src="/assets/img/library.svg" alt="" aria-hidden="true" />
<h5>Library</h5>
</div>
<div class="card-body">
<p class="card-text">
Install with NuGet and use GitVersion as a software library.
Although this is an unsupported option and the API may break
even between minor or patch releases, it's a useful option to
some.
</p>
<a href="/docs/usage/library" class="btn btn-primary">
Library
</a>
</div>
</div>
</div>
<p>
If you're unsure about how you should consume GitVersion or want to
learn more about how it works, read the sections below.
</p>
<h1><a href="/docs/reference/index">Reference</a></h1>
<p>Technical reference documentation.</p>
<div class="box">
<div class="box-body no-padding">
<table
class="table table-striped table-hover two-cols-alt table-responsive"
>
<tbody>
<tr>
<td>
<strong
><a href="/docs/reference/configuration"
>Configuration</a
></strong
>
</td>
<td>
Details about how GitVersion can be configured to suit
your needs
</td>
</tr>
<tr>
<td>
<strong
><a href="/docs/reference/variables"
>Version Variables</a
></strong
>
</td>
<td>The version variables exposed by GitVersion</td>
</tr>
<tr>
<td>
<strong
><a href="/docs/reference/requirements"
>Requirements</a
></strong
>
</td>
<td>Requirements for successful operation of GitVersion</td>
</tr>
<tr>
<td>
<strong
><a href="/docs/reference/version-increments"
>Version Incrementing</a
></strong
>
</td>
<td>
Details on how GitVersion performs version increments
</td>
</tr>
<tr>
<td>
<strong
><a href="/docs/reference/version-sources"
>Version Sources</a
></strong
>
</td>
<td>
Details on how GitVersion finds a source for its generated
version number
</td>
</tr>
<tr>
<td>
<strong
><a href="/docs/reference/modes"
>Versioning Modes</a
></strong
>
</td>
<td>
The different modes of versioning GitVersion supports
</td>
</tr>
<tr>
<td>
<strong
><a href="/docs/reference/build-servers"
>Build Servers</a
></strong
>
</td>
<td>Details on GitVersion's Build Server support</td>
</tr>
</tbody>
</table>
</div>
</div>
<h1><a href="/docs/learn/index">Learn</a></h1>
<p>More in depth information about GitVersion</p>
<div class="box">
<div class="box-body no-padding">
<table
class="table table-striped table-hover two-cols-alt table-responsive"
>
<tbody>
<tr>
<td>
<strong
><a href="/docs/learn/how-it-works"
>How it works</a
></strong
>
</td>
<td></td>
</tr>
<tr>
<td>
<strong
><a href="/docs/learn/intro-to-semver"
>Intro to SemVer</a
></strong
>
</td>
<td></td>
</tr>
<tr>
<td>
<strong
><a href="/docs/learn/dynamic-repositories"
>Dynamic Repositories</a
></strong
>
</td>
<td></td>
</tr>
<tr>
<td>
<strong
><a href="/docs/learn/git-setup">Git Setup</a></strong
>
</td>
<td></td>
</tr>
<tr>
<td>
<strong><a href="/docs/learn/faq">FAQ</a></strong>
</td>
<td></td>
</tr>
<tr>
<td>
<strong
><a href="/docs/learn/why"
>Why use GitVersion?</a
></strong
>
</td>
<td></td>
</tr>
<tr>
<td>
<strong
><a href="/docs/learn/who"
>Who is using GitVersion</a
></strong
>
</td>
<td></td>
</tr>
<tr>
<td>
<strong><a href="/docs/learn/credits">Credits</a></strong>
</td>
<td></td>
</tr>
<tr>
<td>
<strong
><a href="/docs/learn/branching-strategies"
>Branching Strategies</a
></strong
>
</td>
<td>
Information about the different branching strategies
supported by GitVersion
</td>
</tr>
</tbody>
</table>
</div>
</div>
</section>
</div>
<!-- Footer -->
<footer class="main-footer"></footer>
</div>
<div class="wrapper bottom-wrapper">
<footer class="bottom-footer">
Generated by <a href="https://wyam2.github.io">Wyam2</a>
</footer>
</div>
<a href="javascript:" id="return-to-top"
><i class="fa fa-chevron-up"></i
></a>
<div class="github-button">
<a href="https://github.com/GitTools/GitVersion"
><i class="fa fa-github"></i> GitHub</a
>
</div>
<script>
// Close the sidebar if we select an anchor link
$(".main-sidebar a[href^='#']:not('.expand')").click(function () {
$(document.body).removeClass("sidebar-open");
});
$(document).ready(function () {
mermaid.initialize({
flowchart: {
useMaxWidth: false,
},
startOnLoad: false,
cloneCssStyles: false,
});
mermaid.init(undefined, ".mermaid");
// Remove the max-width setting that Mermaid sets
var mermaidSvg = $(".mermaid svg");
mermaidSvg.addClass("img-responsive");
mermaidSvg.css("max-width", "");
// Make it scrollable
var target = document.querySelector(".mermaid svg");
if (target !== null) {
var panZoom = (window.panZoom = svgPanZoom(target, {
zoomEnabled: true,
controlIconsEnabled: true,
fit: true,
center: true,
maxZoom: 20,
zoomScaleSensitivity: 0.6,
}));
// Do the reset once right away to fit the diagram
panZoom.resize();
panZoom.fit();
panZoom.center();
$(window).resize(function () {
panZoom.resize();
panZoom.fit();
panZoom.center();
});
}
$("pre code").each(function (i, block) {
hljs.highlightBlock(block);
});
});
hljs.initHighlightingOnLoad();
// Back to top
$(window).scroll(function () {
if ($(this).scrollTop() >= 200) {
// If page is scrolled more than 50px
$("#return-to-top").fadeIn(1000); // Fade in the arrow
} else {
$("#return-to-top").fadeOut(1000); // Else fade out the arrow
}
});
$("#return-to-top").click(function () {
// When arrow is clicked
$("body,html").animate(
{
scrollTop: 0, // Scroll to top of body
},
500,
);
});
</script>
</body>
</html>