Skip to content

Fix documentation links #697

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 19, 2015
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions docs/build-server-support/build-server-support.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# Build Server Support
GitVersion has support for quite a few build servers out of the box. Currently we support:

- [AppVeyor](build-server-support/build-server/appveyor.md)
- [Bamboo](build-server-support/build-server/bamboo.md)
- [Continua CI](build-server-support/build-server/continua.md)
- [Jenkins](build-server-support/build-server/jenkins.md)
- [MyGet](build-server-support/build-server/myget.md)
- [Octopus Deploy](build-server-support/build-server/octopus-deploy.md)
- [TeamCity](build-server-support/build-server/teamcity.md)
- [Team Build (TFS)](build-server-support/build-server/teambuild.md)
- [TFS Build vNext](build-server-support/build-server/tfs-build-vnext.md)
- [AppVeyor](build-server/appveyor.md)
- [Bamboo](build-server/bamboo.md)
- [Continua CI](build-server/continua.md)
- [Jenkins](build-server/jenkins.md)
- [MyGet](build-server/myget.md)
- [Octopus Deploy](build-server/octopus-deploy.md)
- [TeamCity](build-server/teamcity.md)
- [Team Build (TFS)](build-server/teambuild.md)
- [TFS Build vNext](build-server/tfs-build-vnext.md)

When GitVersion.exe is run with the `/output buildserver` flag instead of outputting Json it will export variables to the current build server.
For instance if you are running in TeamCity after you run `GitVersion /output buildserver` you will have the `%system.GitVersion.SemVer%` available for you to use

When running in MSBuild either from the [MSBuild Task](usage/msbuild-task) or by using the `/proj myproject.sln` parameter, GitVersion will make the MSBuild variables available in the format `$(GitVersion_SemVer)`.
When running in MSBuild either from the [MSBuild Task](/usage/msbuild-task) or by using the `/proj myproject.sln` parameter, GitVersion will make the MSBuild variables available in the format `$(GitVersion_SemVer)`.
2 changes: 1 addition & 1 deletion docs/build-server-support/build-server/teamcity.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ TeamCity has support for meta-runners which allow custom tasks. There is a GitVe

## Running inside TeamCity
* Make sure to use **agent checkouts** (required, server checkouts do not copy the needed `.git` directory)
- If you want to use *checkout on server*, see [dynamic repositories](../dynamic-repositories.md)
- If you want to use *checkout on server*, see [dynamic repositories](../../dynamic-repositories.md)
* For the moment you need to promote the `%teamcity.build.vcs.branch.{configurationid}%` build parameter to an environment variable with the same name for pull requests to be handled correctly
* We update the TC build number to the GitVersion number automatically
* 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
Expand Down
2 changes: 1 addition & 1 deletion docs/build-server-support/build-server/tfs-build-vnext.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ In Team Foundation Build (the web based build system) you can call GitVersion ei
### Using GitVersion with the MSBuild Task NuGet Package
1. Add the [GitVersionTask](https://www.nuget.org/packages/GitVersionTask/) NuGet package to your projects.

See [MSBuild Task](/usage/#msbuild-task) for further instructions how to use the MS Build Task.
See [MSBuild Task](/usage/msbuild-task) for further instructions how to use the MS Build Task.

### Using GitVersion with the Command Line build step
1. Make sure to have GitVersion.exe under version control. There exists also a [Chocolatey package](https://chocolatey.org/packages/GitVersion.Portable) for installing GitVersion.exe on build agents.
Expand Down
2 changes: 1 addition & 1 deletion docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The configuration options are:

- `next-version`: Allows you to bump the next version explicitly, useful for bumping `master` or a feature with breaking changes a major increment.
- `assembly-versioning-scheme`: When updating assembly info tells GitVersion how to treat the AssemblyVersion attribute. Useful to lock the major when using Strong Naming.
- `mode`: Either ContinuousDelivery or ContinuousDeployment. See [Octopus Deploy/CI Build NuGet Packages](#continuousdeployment) above for more information
- `mode`: Either [ContinuousDelivery](/reference/continuous-delivery/) or [ContinuousDeployment](/reference/continuous-deployment/).
- `Continuous-Delivery-fallback-tag`: When using `mode: ContinuousDeployment` the value specified will be used as the pre-release tag for branches which do not have one specified.
- `tag-prefix`: A regex which is used to trim git tags before processing (eg v1.0.0). Default is `[vV]` though this is just for illustrative purposes as we do a IgnoreCase match and could be `v`

Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,4 @@ You can just run `GitVersion.exe` in your repository to see what variables are a
## Exe or MSBuild Task
There are two ways to consume GitVersion, the first is by running GitVersion.exe. The second is an MSBuild task. The MSBuild task is really easy to get up and running, simply install GitVersionTask from NuGet and it will integrate into your project and write out variables to your build server if it's running on one. The exe offers more options and works for not just .net projects.

Read more about [using GitVersion](usage.md)
Read more about [using GitVersion](usage/usage.md)
4 changes: 2 additions & 2 deletions docs/usage/command-line.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ Switches are available with `GitVersion /?`

## Output

By default GitVersion returns a json object to stdout containing all the [variables](more-info/variables.md) which GitVersion generates. This works great if you want to get your build scripts to parse the json object then use the variables, but there is a simpler way.
By default GitVersion returns a json object to stdout containing all the [variables](../more-info/variables.md) which GitVersion generates. This works great if you want to get your build scripts to parse the json object then use the variables, but there is a simpler way.

`GitVersion.exe /output buildserver` will change the mode of GitVersion to write out the variables to whatever build server it is running in. You can then use those variables in your build scripts or run different tools to create versioned NuGet packages or whatever you would like to do. See [build servers](build-server-support/build-server-support.md) for more information about this.
`GitVersion.exe /output buildserver` will change the mode of GitVersion to write out the variables to whatever build server it is running in. You can then use those variables in your build scripts or run different tools to create versioned NuGet packages or whatever you would like to do. See [build servers](../build-server-support/build-server-support.md) for more information about this.

## Inject version metadata into the assembly
`GitVersion.exe /updateassemblyinfo` will recursively search for all `AssemblyInfo.cs` files in the git repo and update them.
Expand Down
6 changes: 3 additions & 3 deletions docs/usage/msbuild-task.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Now when you build:

### Other injected Variables

All other [variables](more-info/variables.md) will be injected into a internal static class.
All other [variables](../more-info/variables.md) will be injected into a internal static class.

```
namespace AssemblyName
Expand Down Expand Up @@ -72,7 +72,7 @@ Trace.WriteLine(versionField.GetValue(null));

Task Name: `GitVersionTask.GetVersion`

At build time all the derived [variables](more-info/variables.md) will be written to MSBuild properties so the information can be used by other tooling in the build pipeline.
At build time all the derived [variables](../more-info/variables.md) will be written to MSBuild properties so the information can be used by other tooling in the build pipeline.

The class for `GitVersionTask.GetVersion` has a property for each variable. However at MSBuild time these properties a mapped to MSBuild properties that are prefixed with `GitVersion_`. This prevents conflicts with other properties in the pipeline.

Expand All @@ -86,7 +86,7 @@ After `GitVersionTask.GetVersion` has executed the properties can be used in the

Task Name: `GitVersionTask.WriteVersionInfoToBuildLog`

If, at build time, it is detected that the build is occurring inside a Build Server server then the [variables](more-info/variables.md) will be written to the build log in a format that the current Build Server can consume. See [Build Server Support](build-server-support/build-server-support.md).
If, at build time, it is detected that the build is occurring inside a Build Server server then the [variables](../more-info/variables.md) will be written to the build log in a format that the current Build Server can consume. See [Build Server Support](../build-server-support/build-server-support.md).

## My Git repository requires authentication. What do I do?

Expand Down
2 changes: 1 addition & 1 deletion docs/usage/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ There are two main ways to consume GitVersion, the first is by running GitVersio
- [Using the Ruby Gem](gem.md)


There exist also wrappers around the [Command Line tool](command-line.md) for several build servers. See [Build server support](build-server-support/build-server-support.md) for details.
There exist also wrappers around the [Command Line tool](command-line.md) for several build servers. See [Build server support](../build-server-support/build-server-support.md) for details.