Skip to content

Commit 52387f6

Browse files
committed
Fix links
1 parent d76a51a commit 52387f6

33 files changed

+180
-138
lines changed

BREAKING_CHANGES.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,6 @@ work for you
4242
`GitVersionConfig.yaml` instead
4343
- GitVersionTask's `ReleaseDateAttribute` no longer exists
4444

45-
[gitflow]: https://gitversion.net/docs/git-branching-strategies/gitflow-examples_complete
45+
[gitflow]: https://gitversion.net/docs/learn/branching-strategies/gitflow-examples_complete
4646
[pr-1541]: https://github.com/GitTools/GitVersion/pull/1541
4747
[pr-1581]: https://github.com/GitTools/GitVersion/pull/1581

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ We love contributions to get started contributing you might need:
55
- [Get started with git](http://rogerdudler.github.io/git-guide)
66
- [How to create a pull request](https://help.github.com/articles/using-pull-requests)
77
- [An issue to work on](https://github.com/GitTools/GitVersion/labels/up-for-grabs) - We are on [Up for grabs](http://up-for-grabs.net/), our up for grabs issues are tagged `up-for-grabs`
8-
- An understanding of our [architecture](http://gitversion.readthedocs.org/en/latest/more-info/how-it-works/#architecture) and how [we write tests](#writing-tests)
8+
- An understanding of our [architecture](http://gitversion.net/docs/learn/how-it-works#architecture) and how [we write tests](#writing-tests)
99

1010
Once you know how to create a pull request and have an issue to work on, just post a comment saying you will work on it.
1111
If you end up not being able to complete the task, please post another comment so others can pick it up.
@@ -23,7 +23,7 @@ Issues are also welcome, [failing tests](#writing-tests) are even more welcome.
2323

2424
## How it works
2525

26-
See [how it works](http://gitversion.readthedocs.org/en/latest/more-info/how-it-works/) in GitVersion's documentation
26+
See [how it works](http://gitversion.net/docs/learn/how-it-works/) in GitVersion's documentation
2727

2828
## Writing Tests
2929

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ from The Noun Project.
8484
[contribute]: https://github.com/GitTools/GitVersion/blob/main/CONTRIBUTING.md
8585
[why]: https://gitversion.net/docs/why
8686
[usage]: https://gitversion.net/docs/usage/usage
87-
[how]: https://gitversion.net/docs/more-info/how-it-works
87+
[how]: https://gitversion.net/docs/learn/how-it-works
8888
[faq]: https://gitversion.net/docs/faq
8989
[who]: https://gitversion.net/docs/who
9090
[gv-in-action]: https://raw.github.com/GitTools/GitVersion/master/docs/input/docs/img/README.png

docs/input/docs/learn/branching-strategies/contribute-examples.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
Order: 70
3-
Title: Creating/Updating Examples
3+
Title: Contribute Examples
4+
Description: Contribute examples of how GitVersion works for your branching strategy
45
---
56

67
The examples are generated by GitVersion tests, there are a number of services

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

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

66
These examples are using the *default* configuration with GitVersion. Which is
7-
[continuous deployment](../reference/versioning-modes/continuous-deployment) mode for
8-
`develop` and [continuous delivery](../reference/versioning-modes/continuous-delivery) mode
7+
[continuous deployment](/docs/reference/modes/continuous-deployment) mode for
8+
`develop` and [continuous delivery](/docs/reference/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).
13+
then tagged. Read more about this at [version increments](/docs/reference/version-increments).
1414

1515
## Feature Branches
1616

1717
Feature branches will take the feature branch name and use that as the
1818
pre-release tag.
1919

20-
![GitFlow](img/05119d0cd4ecaaefff94_feature-branch.png)
20+
![GitFlow](/docs/img/05119d0cd4ecaaefff94_feature-branch.png)
2121

2222
Notice after the feature branch is merged, the version on `develop` is
2323
`1.3.0-alpha.3`. This is due to `develop` running in *continuous deployment*
@@ -35,29 +35,29 @@ commit, the following commit would increase to `-beta.2`.
3535
Because feature branches are most likely pushed to a fork, we are showing the
3636
pull request branch name which is created when you submit a pull request
3737

38-
![GitFlow](img/09fdf46995b771f3164a_pull-request.png)
38+
![GitFlow](/docs/img/09fdf46995b771f3164a_pull-request.png)
3939

4040
## Hotfix Branches
4141

4242
Hotfix branches are used when you need to do a *patch* release in GitFlow and
4343
are always created off `main`
4444

45-
![GitFlow](img/f26ae57adbd9b74f74c4_hotfix.png)
45+
![GitFlow](/docs/img/f26ae57adbd9b74f74c4_hotfix.png)
4646

4747
## Minor Release Branches
4848

4949
Release branches are used for both major and minor releases for stabilisation
5050
before a release. Release branches are taken off `develop` then merged to both
5151
`develop` and `main`. Finally `main` is tagged with the released version.
5252

53-
![GitFlow](img/6d33d35a70a777608fa1_minor-release.png)
53+
![GitFlow](/docs/img/6d33d35a70a777608fa1_minor-release.png)
5454

5555
## Major Release Branches
5656

5757
Major releases are just like minor releases, the difference is you bump the
5858
major in the release branch name.
5959

60-
![GitFlow](img/39f9d8b8b007c82f1f80_major-release.png)
60+
![GitFlow](/docs/img/39f9d8b8b007c82f1f80_major-release.png)
6161

6262
## Support Branches
6363

@@ -74,12 +74,21 @@ Depending on what you name your support branch, you may or may not need a hotfix
7474
branch. Naming it `support/1.x` will automatically bump the patch, if you name
7575
it `support/1.3.0` then the version in branch name rule will kick in and the
7676
patch *will not* automatically bump, meaning you have to use hotfix branches.
77-
![GitFlow](img/b035b8ca99bd34239518_support-hotfix.png)
77+
![GitFlow](/docs/img/b035b8ca99bd34239518_support-hotfix.png)
7878

7979
### Minor Release
8080

81-
![GitFlow](img/2167fb1c4a5cf84edfd8_support-minor.png)
81+
![GitFlow](/docs/img/2167fb1c4a5cf84edfd8_support-minor.png)
8282

83-
## To Update/Contribute
83+
## To Contribute
8484

85-
See [creating/updating examples](creating-updating-examples)
85+
See [contributing examples](/docs/learn/branching-strategies/contribute-examples).
86+
87+
## Complete Example
88+
89+
![GitFlow](http://uml.mvnsearch.org/gist/cf053d7f5d336ae9f7bb)
90+
91+
### Source
92+
93+
See `DocumentationSamples.GitFlowExample`. To update, modify then run test.
94+
Update [https://gist.github.com/JakeGinnivan/cf053d7f5d336ae9f7bb](https://gist.github.com/JakeGinnivan/cf053d7f5d336ae9f7bb)

docs/input/docs/learn/branching-strategies/gitflow/index.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
---
22
Order: 20
3-
Title: GitFlow
3+
Title: Git Flow
4+
Description: The Git Flow branching strategy allows for more structured releases
45
---
56

6-
GitFlow allows more structured releases, and GitVersion will derive sensible
7+
Git Flow allows more structured releases, and GitVersion will derive sensible
78
SemVer compatible versions from this structure.
89

910
## Resources

docs/input/docs/learn/branching-strategies/githubflow/examples.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ Title: GitHubFlow Examples
55

66
## Feature branch
77

8-
![GitHubFlow](img/githubflow_feature-branch.png)
8+
![GitHubFlow](/docs/img/githubflow_feature-branch.png)
99

1010
## Pull requests
1111

12-
![GitHubFlow](img/githubflow_pull-request.png)
12+
![GitHubFlow](/docs/img/githubflow_pull-request.png)
1313

1414
## Release branch
1515

@@ -21,4 +21,4 @@ into, and it's non-breaking) otherwise you can create a release branch for the
2121
next major version. You can then submit pull requests to the long lived feature
2222
branch or the release branch.
2323

24-
![GitFlow](img/githubflow_release-branch.png)
24+
![GitFlow](/docs/img/githubflow_release-branch.png)

docs/input/docs/learn/branching-strategies/githubflow/index.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
Order: 30
3-
Title: GitHubFlow
3+
Title: GitHub Flow
4+
Description: GitHub flow is a simpler and pull request-driven branching strategy
45
---
56

67
GitHubFlow is a simple and effective branching strategy which the folks at
@@ -9,15 +10,15 @@ are much better off with a simpler workflow.
910

1011
GitHubFlow is in a nutshell:
1112

12-
1. Update main to latest [upstream](../reference/git-setup#upstream) code
13+
1. Update main to latest [upstream](/docs/learn/git-setup#upstream) code
1314
1. Create a feature branch `git checkout -b myFeatureBranch`
1415
1. Do the feature/work
15-
1. Push feature branch to [origin](../reference/git-setup#origin)
16+
1. Push feature branch to [origin](/docs/learn/git-setup#origin)
1617
1. Create pull request from origin/<featureBranch> -> upstream/main
1718
1. Review, fix raised comments, merge your PR or even better, get someone else to.
1819

1920
The main rule of GitHub Flow is that main should *always* be deployable.
20-
GitHub Flow allows and encourages [continuous delivery](../reference/versioning-modes/continuous-delivery).
21+
GitHub Flow allows and encourages [continuous delivery](/docs/reference/modes/continuous-delivery).
2122

2223
## Resources
2324

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

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
Order: 10
3-
Title: Home
3+
Title: Overview
4+
Description: An overview of the different branching strategies supported by GitVersion
45
---
56

67
There are two mainstream branching strategies in git and many lesser known
@@ -17,22 +18,22 @@ associated workflows then you will likely lose work at some point. At the start
1718
of any project I recommend picking a branching strategy and making sure your
1819
whole team understands it.
1920

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

23-
### GitHubFlow
24+
### GitHub Flow
2425

2526
GitHubFlow is a simple and powerful branching strategy. It is what GitHub uses
2627
and the branching strategy most open source projects use.
2728

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

35-
### GitFlow
36+
### Git Flow
3637

3738
GitFlow is a more complex and complete branching strategy. It also gives much
3839
more control over when features and code is released.
@@ -55,4 +56,12 @@ fixes/smaller features are still going into the current release
5556

5657
But if you do not have a good reason to go with GitFlow, then start with
5758
GitHubFlow. It is a far simpler model and if you end up needing GitFlow later,
58-
it is [easy to convert](converting-to-gitflow)
59+
it is [easy to convert][converting-to-gitflow].
60+
61+
[continuous-delivery]: /docs/reference/modes/continuous-delivery
62+
[converting-to-gitflow]: /docs/learn/branching-strategies/gitflow/converting-to-gitflow
63+
[feature-branches]: /docs/learn/branching-strategies/gitflow/examples#feature-branches
64+
[gitflow]: /docs/learn/branching-strategies/gitflow
65+
[githubflow]: /docs/learn/branching-strategies/githubflow
66+
[mainline]: /docs/reference/modes/mainline
67+
[pull-request]: /docs/learn/branching-strategies/gitflow/examples#pull-requests

docs/input/docs/learn/faq.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,28 +6,28 @@ 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)
9+
*release*. Read more at [version increments](/docs/reference/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).
15+
options at [octopus deploy](/docs/reference/build-servers/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) which solves this by
21+
[dynamic repositories](/docs/learn/dynamic-repositories) which solves this by
2222
cloning the repository and working against that clone instead of the working
2323
directory.
2424

2525
## I don't understand what SemVer is all about
2626

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

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

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

docs/input/docs/learn/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), meaning most of the
10+
v3 is driven by [configuration](/docs/reference/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/learn/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 explanation 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 main 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) 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](/docs/reference/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/build-servers/azure-devops.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ task into your TFS or Azure DevOps Pipeline instance.
2020
1. Add the [GitVersionTask](https://www.nuget.org/packages/GitVersionTask/)
2121
NuGet package to your projects.
2222

23-
See [MSBuild Task](../../usage/msbuild-task) for further instructions how to use the
24-
MS Build Task.
23+
See [MSBuild Task](/docs/usage/msbuild) for further instructions how to use
24+
the MS Build Task.
2525

2626
### Using GitVersion with the Command Line build step
2727

@@ -125,7 +125,7 @@ To use these variables you can just refer to them using the standard variable
125125
syntax. For instance `$(GitVersion.NuGetVersion)` in your nuget pack task to set
126126
the version number. Since update 1 there are no known limitations.
127127

128-
See [Variables](../../more-info/variables) for an overview of available variables.
128+
See [Variables](/docs/reference/variables) for an overview of available variables.
129129

130130
#### Using GitVersion variables in build name
131131

@@ -145,7 +145,7 @@ If you currently use `$(rev:.r)` in your build number, that won't
145145
work correctly if you
146146
use GitVersion variables as well due to the delayed expansion of the GitVersion
147147
vars. Instead, you might be able to use `$(GitVersion_BuildMetaData)` to achieve
148-
a similar result. See [Variables](../../more-info/variables) for more info on the
148+
a similar result. See [Variables](/docs/reference/variables) for more info on the
149149
variables.
150150
:::
151151

docs/input/docs/reference/build-servers/gitlab.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,6 @@ Title: GitLab CI
44
Description: Details on the GitLab CI support in GitVersion
55
---
66

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

docs/input/docs/reference/build-servers/index.cshtml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
Order: 3000
3-
Description: Build Servers
3+
Description: Details on GitVersion's Build Server support
44
---
55

66
<p>
@@ -34,7 +34,7 @@ Description: Build Servers
3434

3535
<p>
3636
When running in MSBuild either from the
37-
<a href="../usage/msbuild-task">MSBuild Task</a> or
37+
<a href="/docs/usage/msbuild">MSBuild Task</a> or
3838
by using the <code>/proj myproject.sln</code> parameter, GitVersion will
3939
make the MSBuild variables available in the format
4040
<code>$(GitVersion_SemVer)`</code>

docs/input/docs/reference/build-servers/octopus-deploy.md

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,16 @@ Description: Details on the Octopus Deploy support in GitVersion
77
While not a build server, there are a few things to consider when using Octopus
88
Deploy with GitVersion.
99

10-
GitVersion follows [continuous delivery](../../reference/versioning-modes/continuous-delivery)
11-
versioning by default. This means builds will keep producing *the same version*
12-
with just metadata differing. For example, when you start a new release (say
13-
`1.0.0`) with git flow, the branch will start with a semver like
14-
`1.0.0-beta.1+0`, and the Octopus NuGet package will have a version of
15-
`1.0.0-beta0001`. As you commit changes to this release branch the *metadata*
16-
of the semver will increase like so: `1.0.0-beta.1+1`, `1.0.0-beta.1+2`, etc.
17-
However, the version of the corresponding Octopus NuGet package will retain the
18-
*same* `1.0.0-beta0001` version you started with. The problem is Octopus Deploy
19-
will prevent you from deploying these revisions because it sees the same NuGet
10+
GitVersion follows [continuous delivery][continuous-delivery] versioning by
11+
default. This means builds will keep producing *the same version* with just
12+
metadata differing. For example, when you start a new release (say `1.0.0`)
13+
with git flow, the branch will start with a semver like `1.0.0-beta.1+0`, and
14+
the Octopus NuGet package will have a version of `1.0.0-beta0001`. As you
15+
commit changes to this release branch the *metadata* of the semver will
16+
increase like so: `1.0.0-beta.1+1`, `1.0.0-beta.1+2`, etc. However, the version
17+
of the corresponding Octopus NuGet package will retain the *same*
18+
`1.0.0-beta0001` version you started with. The problem is Octopus Deploy will
19+
prevent you from deploying these revisions because it sees the same NuGet
2020
package version and thinks nothing has changed.
2121

2222
Because Octopus Deploy uses NuGet like this you cannot continue to push
@@ -169,8 +169,11 @@ if ($versionInfo.PreReleaseTag -eq '')
169169
}
170170
```
171171

172-
### Configure GitVersion to [increment per commit](../../more-info/incrementing-per-commit)
172+
### Configure GitVersion to Increment Per Commit
173173

174-
As mentioned above, this means you will burn multiple versions per release. This
175-
might not be an issue for you, but can confuse consumers of your library as the
176-
version has semantic meaning.
174+
As mentioned above, [incrementing per commit][increment-per-commit] means you
175+
will burn multiple versions per release. This might not be an issue for you, but
176+
can confuse consumers of your library as the version has semantic meaning.
177+
178+
[continuous-delivery]: /docs/reference/modes/continuous-delivery
179+
[increment-per-commit]: /docs/reference/version-increments#incrementing-per-commit

docs/input/docs/reference/build-servers/teamcity.md

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

61-
See [dynamic repositories](../../more-info/dynamic-repositories) for more info.
61+
See [dynamic repositories](/docs/learn/dynamic-repositories) for more info.
6262

6363
### Output
6464

0 commit comments

Comments
 (0)