Support for Visual Studio Online Build vNext - VSO Build Step #562
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| # Visual Studio Online (Build vNext) Setup | ||
| ## Basic Usage | ||
| In [Visual Studio Online](https://www.visualstudio.com/) build vNext (the web based build system) you can add a build step as follows: | ||
|
|
||
| * **Build Step:** Command Line | ||
| * Might need to fully qualify the path. | ||
| * Tip: Use a script and/or another command step to call `NuGet Install GitVersion.CommandLine` first so you don't have to check in the exe. | ||
| * **Tool:** `GitVersion.exe` | ||
| * **Arguments:** `/output buildserver /updateassemblyinfo true` | ||
|
|
||
| Then in your build parameters simply [add a placeholder](#nuget-in-teamcity) of the GitVersion variables you would like to use. | ||
|
There was a problem hiding this comment. This seems like copy/past from TeamCity documentation and not accurate for this PR |
||
|
|
||
| GitVersion writes build parameters into VSO, so they will automatically be passed to your build scripts to use. | ||
|
There was a problem hiding this comment. I don't think this works at the moment |
||
|
|
||
| ## GitVersion Build Step for VSO | ||
| Visual Studio Online has support for custom build steps. This is planned but TBD. For now, the command line does work. | ||
|
|
||
|
|
||
| ## Running inside TeamCity | ||
|
There was a problem hiding this comment. This seems like copy/past from TeamCity documentation and not accurate for this PR There was a problem hiding this comment. It was and it did work originally....will update! That's on the to do notes at the top :) |
||
| * We output the individual values of the GitVersion version as the build parameter: `GitVersion.*` (Eg: `GitVersion.Major`) if you need access to them in your build script | ||
|
|
||
| ### NuGet in VSO | ||
| * Add dummy parameter to the project called `GitVersion.NuGetVersion`. | ||
| * Then setup you nuget pack build set the "version" to `%GitVersion.NuGetVersion%` | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| using GitVersion; | ||
| using NUnit.Framework; | ||
|
|
||
| [TestFixture] | ||
| public class VsoAgentTests | ||
| { | ||
| [Test] | ||
| public void Develop_branch() | ||
| { | ||
| var versionBuilder = new VsoAgent(); | ||
| var vsVersion = versionBuilder.GenerateSetVersionMessage("0.0.0-Unstable4"); | ||
| // Assert.AreEqual("##vso[task.setvariable variable=GitBuildNumber;]0.0.0-Unstable4", vsVersion); | ||
|
|
||
| Assert.Null(vsVersion); | ||
|
There was a problem hiding this comment. Minor thing, but using Shouldly will give much better error messages. I think I am going to move to xUnit so there is not the option for using the inbuilt assertions, not going to block PR though, I will cleanup later |
||
| } | ||
|
|
||
| [Test] | ||
| public void EscapeValues() | ||
| { | ||
| var versionBuilder = new VsoAgent(); | ||
| var vsVersion = versionBuilder.GenerateSetParameterMessage("Foo", "0.8.0-unstable568 Branch:'develop' Sha:'ee69bff1087ebc95c6b43aa2124bd58f5722e0cb'"); | ||
| Assert.AreEqual("##vso[task.setvariable variable=GitVersion.Foo;]0.8.0-unstable568 Branch:'develop' Sha:'ee69bff1087ebc95c6b43aa2124bd58f5722e0cb'", vsVersion[0]); | ||
|
|
||
| } | ||
|
|
||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| <?xml version="1.0" encoding="utf-8"?> | ||
| <configuration> | ||
| <runtime> | ||
| <assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1"> | ||
| <dependentAssembly> | ||
| <assemblyIdentity name="Mono.Cecil" publicKeyToken="0738eb9f132ed756" culture="neutral" /> | ||
| <bindingRedirect oldVersion="0.0.0.0-0.9.6.0" newVersion="0.9.6.0" /> | ||
| </dependentAssembly> | ||
| </assemblyBinding> | ||
| </runtime> | ||
| </configuration> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| namespace GitVersion | ||
| { | ||
| using System; | ||
|
|
||
| public class VsoAgent : BuildServerBase | ||
| { | ||
| public override bool CanApplyToCurrentContext() | ||
| { | ||
| return !string.IsNullOrEmpty(Environment.GetEnvironmentVariable("TF_BUILD")); | ||
| } | ||
|
|
||
| public override string[] GenerateSetParameterMessage(string name, string value) | ||
| { | ||
| return new[] | ||
| { | ||
| string.Format("##vso[task.setvariable variable=GitVersion.{0};]{1}", name, value) | ||
| }; | ||
| } | ||
|
|
||
| public override string GenerateSetVersionMessage(string versionToUseForBuildNumber) | ||
| { | ||
| // Note: the VSO agent does not yet support updating the build display number from a variable | ||
| return null; | ||
| } | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| <?xml version="1.0" encoding="utf-8"?> | ||
| <configuration> | ||
| <runtime> | ||
| <assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1"> | ||
| <dependentAssembly> | ||
| <assemblyIdentity name="Mono.Cecil" publicKeyToken="0738eb9f132ed756" culture="neutral" /> | ||
| <bindingRedirect oldVersion="0.0.0.0-0.9.6.0" newVersion="0.9.6.0" /> | ||
| </dependentAssembly> | ||
| </assemblyBinding> | ||
| </runtime> | ||
| </configuration> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why command line when this PR is about a custom build step?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's old and needs to change. That refers to using GitVersion.exe as a standalone. That won't get past the detached head issues that the VSO build step does. I'll update the docs.