Skip to content

Commit cc5b8e4

Browse files
committed
Merge pull request #819 from pascalberger/VSTSExtensionDoc
Vsts extension doc
2 parents 3a479bc + 1ec5e77 commit cc5b8e4

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

docs/build-server-support/build-server/tfs-build-vnext.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Team Foundation Build (vNext) Setup
22
## Basic Usage
3-
In Team Foundation Build (the web based build system) you can call GitVersion either using the Command Line build step or install a custom build step. The custom build step requires a one-time setup to import the GitVersion task into your TFS or VSO instance.
3+
In Team Foundation Build (the web based build system) you can call GitVersion either using the Command Line build step or install an extension / custom build step. The custom build step requires a one-time setup to import the GitVersion task into your TFS or VSTS instance.
44

55
## Executing GitVersion
66
### Using GitVersion with the MSBuild Task NuGet Package
@@ -17,7 +17,13 @@ See [MSBuild Task](/usage/msbuild-task) for further instructions how to use the
1717
6. If you want to update the build number you need to send a [logging command](https://github.com/Microsoft/vso-agent-tasks/blob/master/docs/authoring/commands.md) to TFS.
1818

1919
### Using the custom GitVersion build step
20-
#### Installing/updating the custom build step
20+
#### Installing
21+
##### Installing the extension
22+
For Visual Studio Team Service or TFS 2015 Update 2 or higher it is recommonded to install the GitVersion extension:
23+
1. Install the [GitVersion Extension](https://marketplace.visualstudio.com/items?itemName=gittools.gitversion).
24+
25+
##### Manually installing/updating the custom build step
26+
If you run TFS 2015 RTM or Update 1 or don't want to install the GitVersion extension you can install the build task manually:
2127
1. Install the `tfx` command line tool as shown [here](https://github.com/Microsoft/tfs-cli/blob/master/README.md#install).
2228
2. For TFS 2015 On-Prem configure Basic Authentication in TFS as shown [here](https://github.com/Microsoft/tfs-cli/blob/master/docs/configureBasicAuth.md).
2329
3. Download the GitVersion TFS build task from the latest release on the [GitVersion releases page](https://github.com/GitTools/GitVersion/releases) and unzip.
@@ -56,6 +62,7 @@ See [Variables](/more-info/variables/) for more info on the variables.
5662

5763
#### Known limitations
5864
* If you are using on premises TFS, make sure you are using at least **TFS 2015 Update 1**, otherwise a few things will not work.
65+
* Installing the extension on an on premise TFS requires at least TFS 2015 Update 2.
5966
* You need to make sure that all tags are fetched for the Git repository, otherwise you may end with wrong versions (e.g. `FullSemVer` like `1.2.0+5` instead of `1.2.0` for tagged releases)
6067
Just checking the `Clean Repository` check box in the build definition settings might not be enough since this will run a `git clean -fdx/reset --hard` without fetching all tags later.
6168
You can force deletion of the whole folder and a re-clone containing all tags by settings the variable `Build.Clean` to `all`.

0 commit comments

Comments
 (0)