Skip to content

Commit 695aa22

Browse files
committed
(doc) Fix internal links
Some had to be updated, others needed to have the .md removed from the link.
1 parent 08f6143 commit 695aa22

22 files changed

+75
-75
lines changed

docs/input/docs/build-server-support/build-server-support.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ instance if you are running in TeamCity after you run
2121
`GitVersion /output buildserver` you will have the `%system.GitVersion.SemVer%`
2222
available for you to use.
2323

24-
When running in MSBuild either from the [MSBuild Task](/usage/msbuild-task) or
24+
When running in MSBuild either from the [MSBuild Task](../usage/msbuild-task) or
2525
by using the `/proj myproject.sln` parameter, GitVersion will make the MSBuild
2626
variables available in the format `$(GitVersion_SemVer)`.
2727

docs/input/docs/build-server-support/build-server/azure-devops.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ task into your TFS or Azure DevOps Pipeline instance.
1717
1. Add the [GitVersionTask](https://www.nuget.org/packages/GitVersionTask/)
1818
NuGet package to your projects.
1919

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

2323
### Using GitVersion with the Command Line build step
@@ -122,7 +122,7 @@ To use these variables you can just refer to them using the standard variable
122122
syntax. For instance `$(GitVersion.NuGetVersion)` in your nuget pack task to set
123123
the version number. Since update 1 there are no known limitations.
124124

125-
See [Variables](/more-info/variables/) for an overview of available variables.
125+
See [Variables](../../more-info/variables) for an overview of available variables.
126126

127127
#### Using GitVersion variables in build name
128128

@@ -139,7 +139,7 @@ If GitVersion does not find any substitutions it will just default to using `Ful
139139
work correctly if you
140140
use GitVersion variables as well due to the delayed expansion of the GitVersion
141141
vars. Instead, you might be able to use `$(GitVersion_BuildMetaData)` to achieve
142-
a similar result. See [Variables](/more-info/variables/) for more info on the
142+
a similar result. See [Variables](../../more-info/variables) for more info on the
143143
variables.
144144

145145
#### Known limitations

docs/input/docs/build-server-support/build-server/gitlab.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,5 @@ Order: 50
33
Title: GitLab CI
44
---
55

6-
To use GitVersion with GitLab CI, either use the [MSBuild Task](/usage/msbuild-task)
6+
To use GitVersion with GitLab CI, either use the [MSBuild Task](../../usage/msbuild-task)
77
or put the GitVersion executable in your runner's `PATH`.

docs/input/docs/build-server-support/build-server/octopus-deploy.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Title: Octopus Deploy
66
While not a build server, there are a few things to consider when using Octopus
77
Deploy with GitVersion.
88

9-
GitVersion follows [continuous delivery](../../reference/continuous-delivery.md)
9+
GitVersion follows [continuous delivery](../../reference/versioning-modes/continuous-delivery)
1010
versioning by default. This means builds will keep producing *the same version*
1111
with just metadata differing. For example, when you start a new release (say
1212
`1.0.0`) with git flow, the branch will start with a semver like
@@ -168,7 +168,7 @@ if ($versionInfo.PreReleaseTag -eq '')
168168
}
169169
```
170170

171-
### Configure GitVersion to [increment per commit](../../more-info/incrementing-per-commit.md)
171+
### Configure GitVersion to [increment per commit](../../more-info/incrementing-per-commit)
172172

173173
As mentioned above, this means you will burn multiple versions per release. This
174174
might not be an issue for you, but can confuse consumers of your library as the

docs/input/docs/build-server-support/build-server/teamcity.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ GitVersion. Server side checkout sends just the files to the agent and not the
5757
actual .git folder. Dynamic repositories will clone your repo into a temp folder
5858
and use it to calculate version information.
5959

60-
See [dynamic repositories](../../more-info/dynamic-repositories.md) for more info.
60+
See [dynamic repositories](../../more-info/dynamic-repositories) for more info.
6161

6262
### Output
6363

docs/input/docs/configuration.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ skip updating the `AssemblyFileVersion` while still updating the
8383

8484
### assembly-file-versioning-format
8585

86-
Set this to any of the available [variables](/more-info/variables) in
86+
Set this to any of the available [variables](./more-info/variables) in
8787
combination (but not necessary) with a process scoped environment variable. It
8888
overwrites the value of `assembly-file-versioning-scheme`. To reference an
8989
environment variable, use `env:` Example Syntax #1:
@@ -106,15 +106,15 @@ the value of `assembly-versioning-scheme`.
106106

107107
### assembly-informational-format
108108

109-
Set this to any of the available [variables](/more-info/variables) to change the
109+
Set this to any of the available [variables](./more-info/variables) to change the
110110
value of the `AssemblyInformationalVersion` attribute. Default set to
111111
`{InformationalVersion}`. It also supports string interpolation
112112
(`{MajorMinorPatch}+{BranchName}`)
113113

114114
### mode
115115

116116
Sets the `mode` of how GitVersion should create a new version. Read more at
117-
[versioning mode](/reference/versioning-mode.md).
117+
[versioning modes](./reference/versioning-modes).
118118

119119
### increment
120120

@@ -166,19 +166,19 @@ none` and `+semver: skip`
166166
### legacy-semver-padding
167167

168168
The number of characters to pad `LegacySemVer` to in the `LegacySemVerPadded`
169-
[variable](/more-info/variables). Is default set to `4`, which will pad the
169+
[variable](./more-info/variables). Is default set to `4`, which will pad the
170170
`LegacySemVer` value of `3.0.0-beta1` to `3.0.0-beta0001`.
171171

172172
### build-metadata-padding
173173

174174
The number of characters to pad `BuildMetaData` to in the `BuildMetaDataPadded`
175-
[variable](/more-info/variables). Is default set to `4`, which will pad the
175+
[variable](./more-info/variables). Is default set to `4`, which will pad the
176176
`BuildMetaData` value of `1` to `0001`.
177177

178178
### commits-since-version-source-padding
179179

180180
The number of characters to pad `CommitsSinceVersionSource` to in the
181-
`CommitsSinceVersionSourcePadded` [variable](/more-info/variables). Is default
181+
`CommitsSinceVersionSourcePadded` [variable](./more-info/variables). Is default
182182
set to `4`, which will pad the `CommitsSinceVersionSource` value of `1` to
183183
`0001`.
184184

@@ -481,7 +481,7 @@ default support/ and master are mainlines.
481481
### pre-release-weight
482482

483483
Provides a way to translate the `PreReleaseLabel`
484-
([variables](/more-info/variables)) to a numeric value in order to avoid version
484+
([variables](./more-info/variables)) to a numeric value in order to avoid version
485485
collisions across different branches. For example, a release branch created
486486
after "1.2.3-alpha.55" results in "1.2.3-beta.1" and thus e.g. "1.2.3-alpha.4"
487487
and "1.2.3-beta.4" would have the same file version: "1.2.3.4". One of the ways

docs/input/docs/examples.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,13 @@ following branch types ootb:
3131
- release/
3232
3333
If you have other branch types GitVersion is entirely configuration driven, so
34-
check out the [Configuration](configuration.md) section of the readme to
34+
check out the [Configuration](configuration) section of the readme to
3535
understand how to make GitVersion work for you.
3636
3737
## GitFlow
3838
39-
[See GitFlow Examples](git-branching-strategies/gitflow-examples.md)
39+
[See GitFlow Examples](git-branching-strategies/gitflow-examples)
4040
4141
## GitHubFlow
4242
43-
[See GitHubFlow Examples](git-branching-strategies/githubflow-examples.md)
43+
[See GitHubFlow Examples](git-branching-strategies/githubflow-examples)

docs/input/docs/faq.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,19 @@ Title: FAQ
66
## Why is my version not incrementing?
77

88
GitVersion calculates the semantic version, this will only change once per
9-
*release*. Read more at [version increments](more-info/version-increments.md)
9+
*release*. Read more at [version increments](more-info/version-increments)
1010

1111
## I'm using Octopus deploy
1212

1313
Because Octopus deploy cannot have the same version of a package to a NuGet
1414
feed. There is no magic solution to this, but you can read more about your
15-
options at [octopus deploy](build-server-support/build-server/octopus-deploy.md).
15+
options at [octopus deploy](build-server-support/build-server/octopus-deploy).
1616

1717
## How can GitVersion run for a shallow clone or checkout on server working directories
1818

1919
GitVersion needs a proper git repository to run, some build servers do not do a
2020
proper clone which can cause issues. GitVersion has a feature called
21-
[dynamic repositories](more-info/dynamic-repositories.md) which solves this by
21+
[dynamic repositories](more-info/dynamic-repositories) which solves this by
2222
cloning the repository and working against that clone instead of the working
2323
directory.
2424

@@ -27,7 +27,7 @@ directory.
2727
Not a problem, we have a quick introduction to SemVer which can be a good primer
2828
to read before reading [SemVer.org](http://semver.org)
2929

30-
Read more at [intro to semver](reference/intro-to-semver.md)
30+
Read more at [intro to semver](reference/intro-to-semver)
3131

3232
## I can't use the build number for NuGet
3333

docs/input/docs/git-branching-strategies/gitflow-examples.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@ Title: GitFlow Examples
44
---
55

66
These examples are using the *default* configuration with GitVersion. Which is
7-
[continuous deployment](../reference/continuous-deployment.md) mode for
8-
`develop` and [continuous delivery](../reference/continuous-delivery.md) mode
7+
[continuous deployment](../reference/versioning-modes/continuous-deployment) mode for
8+
`develop` and [continuous delivery](../reference/versioning-modes/continuous-delivery) mode
99
for all other branches.
1010

1111
This default configuration allows you to publish CI builds from develop to a CI
1212
MyGet feed, or another CI feed. Then all other branches are manually released
13-
then tagged. Read more about this at [version increments](../more-info/version-increments.md).
13+
then tagged. Read more about this at [version increments](../more-info/version-increments).
1414

1515
## Feature Branches
1616

@@ -82,4 +82,4 @@ patch *will not* automatically bump, meaning you have to use hotfix branches.
8282

8383
## To Update/Contribute
8484

85-
See [creating/updating examples](creating-updating-examples.md)
85+
See [creating/updating examples](creating-updating-examples)

docs/input/docs/git-branching-strategies/githubflow.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@ are much better off with a simpler workflow.
99

1010
GitHubFlow is in a nutshell:
1111

12-
1. Update master to latest [upstream](../reference/git-setup.md#upstream) code
12+
1. Update master to latest [upstream](../reference/git-setup#upstream) code
1313
1. Create a feature branch `git checkout -b myFeatureBranch`
1414
1. Do the feature/work
15-
1. Push feature branch to [origin](../reference/git-setup.md#origin)
15+
1. Push feature branch to [origin](../reference/git-setup#origin)
1616
1. Create pull request from origin/<featureBranch> -> upstream/master
1717
1. Review, fix raised comments, merge your PR or even better, get someone else to.
1818

1919
The main rule of GitHub Flow is that master should *always* be deployable.
20-
GitHub Flow allows and encourages [continuous delivery](../reference/continuous-delivery.md).
20+
GitHub Flow allows and encourages [continuous delivery](../reference/versioning-modes/continuous-delivery).
2121

2222
## Resources
2323

docs/input/docs/git-branching-strategies/overview.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,18 +17,18 @@ associated workflows then you will likely lose work at some point. At the start
1717
of any project I recommend picking a branching strategy and making sure your
1818
whole team understands it.
1919

20-
As mentioned above the GitVersion docs cover [GitHubFlow](githubflow.md) and
21-
[GitFlow](gitflow.md).
20+
As mentioned above the GitVersion docs cover [GitHubFlow](githubflow) and
21+
[GitFlow](gitflow).
2222

2323
### GitHubFlow
2424

2525
GitHubFlow is a simple and powerful branching strategy. It is what GitHub uses
2626
and the branching strategy most open source projects use.
2727

28-
- [Mainline development](../reference/mainline-development.md) on `master`
29-
- Work on [feature branches](../reference/feature-branches.md), merge into
30-
`master` via [pull requests](../reference/pull-requests.md)
31-
- Works well for [continuous delivery](../reference/continuous-delivery.md)
28+
- [Mainline development](../reference/versioning-modes/mainline-development) on `master`
29+
- Work on [feature branches](../reference/feature-branches), merge into
30+
`master` via [pull requests](../reference/pull-requests)
31+
- Works well for [continuous delivery](../reference/versioning-modes/continuous-delivery)
3232
- Does not have a way to manage/maintain old releases
3333
- Only allows working on a single release at a time
3434

@@ -55,4 +55,4 @@ fixes/smaller features are still going into the current release
5555

5656
But if you do not have a good reason to go with GitFlow, then start with
5757
GitHubFlow. It is a far simpler model and if you end up needing GitFlow later,
58-
it is [easy to convert](converting-to-gitflow.md)
58+
it is [easy to convert](converting-to-gitflow)

docs/input/docs/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ This trips a lot of people up, by default GitVersion *does not* increment the
3030
SemVer every commit. This means that you will get multiple builds producing the
3131
*same version* of your application.
3232

33-
Read more at [version increments](more-info/version-increments.md)
33+
Read more at [version increments](more-info/version-increments)
3434

3535
### Version sources
3636

@@ -44,15 +44,15 @@ There are a number of sources GitVersion can get its versions from, they include
4444
increments so does develop)
4545
- GitVersion.yml file (e.g `next-version: 2.0.0`)
4646

47-
Read more at [version sources](more-info/version-sources.md)
47+
Read more at [version sources](more-info/version-sources)
4848

4949
## Configuration
5050

5151
GitVersion v3 was rewritten to be very configuration driven rather than
5252
hardcoding git workflows into it. This has made it a lot more flexible.
5353
Configuration options can be set globally or per branch.
5454

55-
Read more about [configuration](configuration.md)
55+
Read more about [configuration](configuration)
5656

5757
## Output Variables
5858

@@ -73,7 +73,7 @@ integrate into your project and write out variables to your build server if it's
7373
running on one. The exe offers more options and works for .NET projects as well
7474
as other project types.
7575

76-
Read more about [using GitVersion](usage/usage.md)
76+
Read more about [using GitVersion](usage/usage)
7777

7878
## Supported languages and frameworks
7979

docs/input/docs/more-info/how-it-works.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ GitVersion v3 works very differently to v2. Version 2 had knowledge of both
77
GitFlow and GitHubFlow hard coded into it, with each branch having it's own
88
class which calculated the version for that branch type.
99

10-
v3 is driven by [configuration](../configuration.md), meaning most of the
10+
v3 is driven by [configuration](../configuration), meaning most of the
1111
behaviors in GitVersion can be tweaked to work the way you want. This also makes
1212
it *much* more predictable and easier to diagnose when odd things are happening.
1313

docs/input/docs/more-info/version-increments.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ feed will see the alpha packages.
5050

5151
### 2. Octopus deploy
5252

53-
See [Octopus deploy](../build-server-support/build-server/octopus-deploy.md)
53+
See [Octopus deploy](../build-server-support/build-server/octopus-deploy)
5454

5555
## Manually incrementing the version
5656

docs/input/docs/reference/intro-to-semver.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,4 @@ For a more complete explaination check out [semver.org](http://semver.org) which
2828
## SemVer in GitVersion
2929
GitVersion makes it easy to follow semantic versioning in your library by automatically calculating the next semantic version which your library/application is likely to use. In [GitFlow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow/) the develop branch will bump the *minor* when master is tagged, while [GitHubFlow](https://guides.github.com/introduction/flow/) will bump the *patch*.
3030

31-
Because one size does not always fit all, GitVersion provides many [Variables](../more-info/variables.md) for you to use which contain different variations of the version. For example SemVer will be in the format `{major}.{minor}.{patch}-{tag}`, but `FullSemVer` will also include build metadata: `{major}.{minor}.{patch}-{tag}+{buildmetadata}`
31+
Because one size does not always fit all, GitVersion provides many [Variables](../more-info/variables) for you to use which contain different variations of the version. For example SemVer will be in the format `{major}.{minor}.{patch}-{tag}`, but `FullSemVer` will also include build metadata: `{major}.{minor}.{patch}-{tag}+{buildmetadata}`

docs/input/docs/reference/versioning-modes/continuous-delivery.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,16 +28,16 @@ set of artifacts to go through your pipeline. Depending on how long your
2828
pipeline is, this could be a while.
2929

3030
GitHubFlow is a better fit for Continuous delivery, the
31-
[mainline development](mainline-development.md) model means that every merged
31+
[mainline development](mainline-development) model means that every merged
3232
feature branch will be built as a *stable* version and if the build/builds go
3333
green then you are free to deploy to production at any time.
3434

3535
## Usage
3636

3737
By default, GitVersion is set up to do Continuous Delivery on all branches but
38-
`develop`, which is set up with [Continuous Deployment](continuous-deployment.md).
38+
`develop`, which is set up with [Continuous Deployment](continuous-deployment).
3939
To change the mode to Continuous Delivery, change your
40-
[configuration](../configuration.md) to:
40+
[configuration](../../configuration) to:
4141

4242
```yaml
4343
mode: ContinuousDelivery

docs/input/docs/reference/versioning-modes/continuous-deployment.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,18 +15,18 @@ on the issues of incrementing automatically.
1515
As such we force a pre-release tag on all branches, this is fine for
1616
applications but can cause problems for libraries. As such this mode may or may
1717
not work for you, which leads us into a new mode in v4 of GitVersion:
18-
[Mainline Development](mainline-development.md).
18+
[Mainline Development](mainline-development).
1919

2020
### Usage
2121

2222
By default GitVersion is set up to do Continuous Deployment versioning on the
2323
`develop` branch, but for all other branches,
24-
[Continuous Delivery](continuous-delivery.md) is the default mode. From version
25-
3 of GitVersion this behavior is [configurable](../configuration.md).
24+
[Continuous Delivery](continuous-delivery) is the default mode. From version
25+
3 of GitVersion this behavior is [configurable](../../configuration).
2626

2727
The default behavior for v3 and how v1 & 2 worked was that the version only
2828
incremented after a tag, which signified a release. In v3 you can simply switch
29-
the default mode in the [configuration](../configuration.md) from
29+
the default mode in the [configuration](../../configuration) from
3030
`ContinuousDelivery` to `ContinuousDeployment` and the version will then
3131
increment each commit, giving you the features of GitVersion with continuous
3232
deployment:

docs/input/docs/reference/versioning-modes/mainline-development.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Title: Mainline Development
44
---
55

66
Mainline Development is enabled when using
7-
[GitHubFlow](../git-branching-strategies/githubflow.md) or any other strategy
7+
[GitHubFlow](../../git-branching-strategies/githubflow) or any other strategy
88
where you develop on `master`. The main rule of mainline development is that
99
**master is always in a state that it could be deployed to production**. This
1010
means that pull requests should not be merged until they are ready to go out.
@@ -44,17 +44,17 @@ Here is an example of what mainline development looks like:
4444
![Mainline mode](../../img/mainline-mode.png)
4545

4646
**WARNING:** This approach can slow down over time, we recommend to tag
47-
intermitently (maybe for minor or major releases) because then GitVersion
47+
intermittently (maybe for minor or major releases) because then GitVersion
4848
will start the version calculation from that point. Much like a snapshot in an
4949
event sourced system. We will probably add in warnings to tag when things are
5050
slowing down.
5151

5252
## Usage
53-
By default GitVersion is set up to do [Continuous Delivery](continuous-delivery.md)
53+
By default GitVersion is set up to do [Continuous Delivery](continuous-delivery)
5454
versioning on all branches but `develop` (which does
55-
[Continuous Deployment](continuous-deployment.md) by default). To change the
56-
[versioning mode](versioning-mode.md) to Mainline Development, just
57-
change the [configuration](../configuration.md) as such:
55+
[Continuous Deployment](continuous-deployment) by default). To change the
56+
[versioning mode](versioning-mode) to Mainline Development, just
57+
change the [configuration](../../configuration) as such:
5858

5959
```yaml
6060
mode: Mainline

0 commit comments

Comments
 (0)