File tree Expand file tree Collapse file tree 8 files changed +51
-11
lines changed
build-server-support/build-server
reference/versioning-modes Expand file tree Collapse file tree 8 files changed +51
-11
lines changed Original file line number Diff line number Diff line change @@ -135,12 +135,16 @@ to configure.
135
135
136
136
If GitVersion does not find any substitutions it will just default to using `FullSemVer`
137
137
138
- **IMPORTANT:** If you currently use `$(rev:.r)` in your build number, that won't
138
+ :::{.alert .alert-danger}
139
+ **Important**
140
+
141
+ If you currently use `$(rev:.r)` in your build number, that won't
139
142
work correctly if you
140
143
use GitVersion variables as well due to the delayed expansion of the GitVersion
141
144
vars. Instead, you might be able to use `$(GitVersion_BuildMetaData)` to achieve
142
145
a similar result. See [Variables](../../more-info/variables) for more info on the
143
146
variables.
147
+ :: :
144
148
145
149
# ### Known limitations
146
150
Original file line number Diff line number Diff line change @@ -19,11 +19,15 @@ generated by GitVersion and apply this [MyGet Environment Variable](http://docs.
19
19
wherever it is used during the build process.
20
20
* Ensure the build script has been pushed to your source repository root. Done :)
21
21
22
- Note: If you require the ` AssemblyInfo.cs ` files in your project to be patched
22
+ :::{.alert .alert-info}
23
+ ** Note**
24
+
25
+ If you require the ` AssemblyInfo.cs ` files in your project to be patched
23
26
with the information from GitVersion, you will have to run it manually, for
24
27
example using the command:
25
28
26
29
` call %GitVersion% /updateassemblyinfo true ` .
30
+ :::
27
31
28
32
Also check [ docs.myget.org] ( http://docs.myget.org/docs/reference/build-services#GitVersion_and_Semantic_Versioning )
29
33
for the latest full info.
Original file line number Diff line number Diff line change @@ -16,8 +16,12 @@ working directory. It can be the root repository directory or any subdirectory
16
16
in case you have a single repository for more than one project or are restricted
17
17
to commit into a subdirectory.
18
18
19
- ** Note:** GitVersion ships with internal default configuration which works with
19
+ :::{.alert .alert-info}
20
+ ** Note**
21
+
22
+ GitVersion ships with internal default configuration which works with
20
23
GitHubFlow and GitFlow, probably with others too.
24
+ :::
21
25
22
26
The * develop* branch is set to ` ContinuousDeployment ` mode by default as we have
23
27
found that is generally what is needed when using GitFlow.
@@ -246,7 +250,11 @@ Custom merge message formats are evaluated _before_ any built in formats.
246
250
247
251
Then we have branch specific configuration, which looks something like this :
248
252
249
- **NOTE: ** v4 changed from using regexes for keys, to named configs
253
+ :::{.alert .alert-info}
254
+ **Note**
255
+
256
+ v4 changed from using regexes for keys, to named configs
257
+ :: :
250
258
251
259
If you have branch specific configuration upgrading to v4 will force you to
252
260
upgrade.
Original file line number Diff line number Diff line change 41
41
So ` 1.0.1-rc.1+5 ` would become ` 1.0.1-rc0001 ` , this takes into account
42
42
characters which are not allowed and NuGets crap sorting.
43
43
44
- ** note: ** The ` NuGetVersion ` variable is floating, so when NuGet 3.0 comes out
44
+ :::{.alert .alert-info}
45
+ ** Note**
46
+
47
+ The ` NuGetVersion ` variable is floating, so when NuGet 3.0 comes out
45
48
with proper SemVer support GitVersion will switch this variable to a proper
46
49
SemVer.
50
+ :::
47
51
48
52
If you want to fix the version, use ` NuGetVersionV2 ` which will stay the same
49
53
after NuGet 3.0 comes out
Original file line number Diff line number Diff line change @@ -43,11 +43,15 @@ Here is an example of what mainline development looks like:
43
43
44
44
![ Mainline mode] ( ../../img/mainline-mode.png )
45
45
46
- ** WARNING:** This approach can slow down over time, we recommend to tag
46
+ :::{.alert .alert-warning}
47
+ ** Warning**
48
+
49
+ This approach can slow down over time, we recommend to tag
47
50
intermittently (maybe for minor or major releases) because then GitVersion
48
51
will start the version calculation from that point. Much like a snapshot in an
49
52
event sourced system. We will probably add in warnings to tag when things are
50
53
slowing down.
54
+ :::
51
55
52
56
## Usage
53
57
By default GitVersion is set up to do [ Continuous Delivery] ( continuous-delivery )
Original file line number Diff line number Diff line change @@ -7,9 +7,13 @@ If you want a command line version installed on your machine then you can use
7
7
[ Chocolatey] ( http://chocolatey.org ) or [ Homebrew] ( https://brew.sh/ ) to install
8
8
GitVersion.
9
9
10
- > ** Hint** : While documentation and help use '/' as command prefix the hyphen '-'
10
+ :::{.alert .alert-info}
11
+ ** Hint**
12
+
13
+ While documentation and help use '/' as command prefix the hyphen '-'
11
14
is supported as well and is a better alternative for usage on \* nix systems.
12
15
Example: * -output json vs. /output json*
16
+ :::
13
17
14
18
## Chocolatey
15
19
Original file line number Diff line number Diff line change @@ -5,8 +5,12 @@ Title: Gem
5
5
6
6
Just a gem wrapper around the command line to make it easier to consume from Rake.
7
7
8
- ** NOTE** This is currently not being pushed.. Please get in touch if you are
9
- using this
8
+ :::{.alert .alert-info}
9
+ ** Note**
10
+
11
+ This is currently not being pushed. Please get in touch if you are
12
+ using this.
13
+ :::
10
14
11
15
If you want a Ruby gem version installed on your machine then you can use
12
16
[ Bundler] ( http://bundler.io/ ) or [ Gem] ( http://rubygems.org/ ) to install the
@@ -45,5 +49,9 @@ include GitVersion
45
49
puts git_version(' C:/read/info/from/another/repository' ).sha
46
50
```
47
51
48
- ** Note:** Mono is not currently supported due to downstream dependencies on
52
+ :::{.alert .alert-info}
53
+ ** Note**
54
+
55
+ Mono is not currently supported due to downstream dependencies on
49
56
libgit2. The Gem can only be used with the .NET framework
57
+ :::
Original file line number Diff line number Diff line change @@ -5,7 +5,11 @@ Title: NuGet Library
5
5
6
6
To use GitVersion from your own code.
7
7
8
- ** Warning, we are not semantically versioning this library and it should be considered unstable.**
8
+ :::{.alert .alert-warning}
9
+ ** Warning**
10
+
11
+ We are not semantically versioning this library and it should be considered unstable.**
12
+ :::
9
13
10
14
It also is not currently documented. Please open an issue if you are consuming
11
15
the library to let us know, and why you need to.
You can’t perform that action at this time.
0 commit comments