Skip to content

Commit 329cedb

Browse files
committed
updated docs to use main instead of master
1 parent c2fbc48 commit 329cedb

22 files changed

+69
-69
lines changed

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ other build steps.
3333
5. If you want the GitVersionTask to update AssemblyInfo files add
3434
`updateAssemblyInfo true` to the Arguments parameter.
3535
6. If you want to update the build number you need to send a
36-
[logging command](https://github.com/Microsoft/azure-pipelines-tasks/blob/master/docs/authoring/commands.md)
36+
[logging command](https://github.com/Microsoft/azure-pipelines-tasks/blob/main/docs/authoring/commands.md)
3737
to TFS.
3838

3939
### Using the custom GitVersion build step
@@ -53,12 +53,12 @@ to install the GitVersion extension:
5353
If you run TFS 2015 RTM or Update 1 or don't want to install the GitVersion
5454
extension you can install the build task manually:
5555

56-
1. Install the `tfx` command line tool as shown [here](https://github.com/Microsoft/tfs-cli/blob/master/README.md#install).
57-
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).
56+
1. Install the `tfx` command line tool as shown [here](https://github.com/Microsoft/tfs-cli/blob/main/README.md#install).
57+
2. For TFS 2015 On-Prem configure Basic Authentication in TFS as shown [here](https://github.com/Microsoft/tfs-cli/blob/main/docs/configureBasicAuth.md).
5858
3. Download the GitVersion TFS build task from the latest release on the
5959
[GitVersion releases page](https://github.com/GitTools/GitVersion/releases) and
6060
unzip.
61-
4. Run `tfx login` as shown [here](https://github.com/Microsoft/tfs-cli/blob/master/README.md#login).
61+
4. Run `tfx login` as shown [here](https://github.com/Microsoft/tfs-cli/blob/main/README.md#login).
6262
5. From the directory outside of where you unzipped the task, run
6363
`tfx build tasks upload --task-path .\GitVersionVsixTask --overwrite` where
6464
GitVersionVsixTask is the directory containing the files.

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,10 +47,10 @@ manual build in your *build server* which pushes the package to Octopus deploy.
4747

4848
Another simple option is to tag a stable version to release, the basic idea is:
4949

50-
1. GitVersion is set to continuous deployment mode, so master will create `-ci.x`
50+
1. GitVersion is set to continuous deployment mode, so main will create `-ci.x`
5151
pre-release builds
5252
1. CI Builds only create NuGet packages for stable builds
53-
1. You tag master with a stable version of the next version then push it
53+
1. You tag main with a stable version of the next version then push it
5454
1. The CI build triggers, GitVersion will always respect tags so you will get a
5555
stable version
5656
1. The stable package will be pushed to Octopus
@@ -98,8 +98,8 @@ if ($pendingChanges -ne $null)
9898
9999
# Pull latest, fast-forward only so that it git stops if there is an error
100100
& git fetch origin
101-
& git checkout master
102-
& git merge origin/master --ff-only
101+
& git checkout main
102+
& git merge origin/main --ff-only
103103
104104
# Determine version to release
105105
$output = & $gitversion /output json
@@ -118,7 +118,7 @@ if ($LASTEXITCODE -ne 0) {
118118
throw "No changes detected since last release"
119119
}
120120
121-
& git push origin master --tags
121+
& git push origin main --tags
122122
123123
Pop-Location
124124
```

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -81,18 +81,18 @@ variables because teamcity will pass them through automatically.
8181

8282
### When TeamCity -> GitHub can't use https
8383

84-
GitVersion requires the presence of master branch in order to determine the
84+
GitVersion requires the presence of main branch in order to determine the
8585
version number. If TeamCity uses https to clone git repos then GitVersion will
86-
pull down master branch for you during the build.
86+
pull down main branch for you during the build.
8787

8888
If however your TeamCity uses SSH to clone git repos and https is unavailable
8989
then GitVersion will error with a message like
9090

9191
> [GitVersionTask.UpdateAssemblyInfo] Error occurred: GitVersion.MissingBranchException:
9292
Could not fetch from '[email protected]:Xero/Bus.git' since LibGit2 does
9393
not support the transport. You have most likely cloned using SSH. If there is a
94-
remote branch named 'master' then fetch it manually, otherwise please create a
95-
local branch named 'master'. ---> LibGit2Sharp.LibGit2SharpException: An error
94+
remote branch named 'main' then fetch it manually, otherwise please create a
95+
local branch named 'main'. ---> LibGit2Sharp.LibGit2SharpException: An error
9696
was raised by libgit2. Category = Net (Error). This transport isn't implemented.
9797
Sorry
9898

docs/input/docs/configuration.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ And the description of the available options are:
6565
6666
### next-version
6767
68-
Allows you to bump the next version explicitly, useful for bumping `master` or a
68+
Allows you to bump the next version explicitly, useful for bumping `main` or a
6969
feature with breaking changes a major increment.
7070

7171
### assembly-versioning-scheme
@@ -148,7 +148,7 @@ continuous-delivery-fallback-tag: ''
148148
...
149149
```
150150

151-
Doing so can be helpful if you use your `master` branch as a `release` branch.
151+
Doing so can be helpful if you use your `main` branch as a `release` branch.
152152

153153
### tag-prefix
154154

@@ -282,7 +282,7 @@ upgrade.
282282

283283
```yaml
284284
branches:
285-
master:
285+
main:
286286
regex: ^master$|^main$
287287
mode: ContinuousDelivery
288288
tag: ''
@@ -373,18 +373,18 @@ Take this commit graph
373373
|/
374374
*
375375
*
376-
* (master)
376+
* (main)
377377
```
378378

379379
By looking at this graph, you cannot tell which of these scenarios happened:
380380

381381
+ feature/foo branches off release/1.0.0
382-
+ Branch release/1.0.0 from master
382+
+ Branch release/1.0.0 from main
383383
+ Branch feature/foo from release/1.0.0
384384
+ Add a commit to both release/1.0.0 and feature/foo
385385
+ release/1.0.0 is the base for feature/foo
386386
+ release/1.0.0 branches off feature/foo
387-
+ Branch feature/foo from master
387+
+ Branch feature/foo from main
388388
+ Branch release/1.0.0 from feature/foo
389389
+ Add a commit to both release/1.0.0 and feature/foo
390390
+ feature/foo is the base for release/1.0.0
@@ -397,7 +397,7 @@ by telling it what types of branches a branch can be created from. For example,
397397
feature branches are, by default, configured to have the following source
398398
branches:
399399

400-
`source-branches: ['master', 'develop', 'feature', 'hotfix', 'support']`
400+
`source-branches: ['main', 'develop', 'feature', 'hotfix', 'support']`
401401

402402
This means that we will never bother to evaluate pull request branches as merge
403403
base options and being explicit in this way also improves the performance of
@@ -420,7 +420,7 @@ A complete example:
420420
branches:
421421
unstable:
422422
regex: ...
423-
is-source-branch-for: ['master', 'develop', 'feature', 'hotfix', 'support']
423+
is-source-branch-for: ['main', 'develop', 'feature', 'hotfix', 'support']
424424
```
425425

426426
Without this configuration value you would have to do:
@@ -460,7 +460,7 @@ Same as for the [global configuration, explained above](#increment).
460460

461461
### prevent-increment-of-merged-branch-version
462462

463-
When `release-2.0.0` is merged into master, we want master to build `2.0.0`. If
463+
When `release-2.0.0` is merged into main, we want main to build `2.0.0`. If
464464
`release-2.0.0` is merged into develop we want it to build `2.1.0`, this option
465465
prevents incrementing after a versioned branch is merged.
466466

@@ -494,7 +494,7 @@ branches:
494494
### track-merge-target
495495

496496
Strategy which will look for tagged merge commits directly off the current
497-
branch. For example `develop` → `release/1.0.0` → merge into `master` and tag
497+
branch. For example `develop` → `release/1.0.0` → merge into `main` and tag
498498
`1.0.0`. The tag is *not* on develop, but develop should be version `1.0.0` now.
499499

500500
### tracks-release-branches
@@ -508,7 +508,7 @@ Indicates this branch config represents a release branch in GitFlow.
508508
### is-mainline
509509

510510
When using Mainline mode, this indicates that this branch is a mainline. By
511-
default support/ and master are mainlines.
511+
default support/ and main are mainlines.
512512

513513
### pre-release-weight
514514

docs/input/docs/examples.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,14 @@ adb29a -> 1.0.1-feature-foo.1+1 (PR #5 Version: `1.0.1-PullRequest.5+2`)
1515
5f413b -> 1.0.1+4
1616
d6155b -> 2.0.0-rc.1+0 (Before and after tag)
1717
d53ab6 -> 2.0.0-rc.2+1 (Pre-release number was bumped because of the tag on previous commit)
18-
b5d142 -> 2.0.0+0 (2.0.0 branch was merged, so master is now at 2.0.0)
18+
b5d142 -> 2.0.0+0 (2.0.0 branch was merged, so main is now at 2.0.0)
1919
```
2020
2121
This is just a small sample of the way GitVersion works. The idea is you just
2222
plug it in and you will get sensible version numbers by default. We support the
2323
following branch types ootb:
2424
25-
- master
25+
- main
2626
- develop
2727
- hotfix/
2828
- feature/

docs/input/docs/git-branching-strategies/converting-to-gitflow.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Converting to GitFlow is simple. Whenever you need to convert, simply do the
77
following
88

99
```shell
10-
git checkout master
10+
git checkout main
1111
git checkout -b develop
1212
git push upstream develop
1313
```

docs/input/docs/git-branching-strategies/creating-updating-examples.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,4 @@ The tests are quite simple. Using the methods on the `fixture` itself will
1616
record that action in the sequence diagram. If you do not want the action
1717
recorded perform the action directly on the repository (`fixture.Repository.`)
1818

19-
The tests for the examples should all live at [DocumentationSamples.cs](https://github.com/GitTools/GitVersion/blob/master/src/GitVersion.Core.Tests/IntegrationTests/DocumentationSamples.cs)
19+
The tests for the examples should all live at [DocumentationSamples.cs](https://github.com/GitTools/GitVersion/blob/main/src/GitVersion.Core.Tests/IntegrationTests/DocumentationSamples.cs)

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,15 +40,15 @@ pull request branch name which is created when you submit a pull request
4040
## Hotfix Branches
4141

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

4545
![GitFlow](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
51-
`develop` and `master`. Finally `master` is tagged with the released version.
51+
`develop` and `main`. Finally `main` is tagged with the released version.
5252

5353
![GitFlow](img/6d33d35a70a777608fa1_minor-release.png)
5454

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

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,15 @@ SemVer compatible versions from this structure.
1111
## Assumptions:
1212

1313
* Using [GitFlow branching model](http://nvie.com/git-model/) which always has a
14-
master and a develop branch
14+
main and a develop branch
1515
* Following [Semantic Versioning](http://semver.org/)
1616
* Planned releases (bumps in major or minor) are done on release branches
1717
prefixed with release-. Eg: release-4.1 (or release-4.1.0)
1818
* Hotfixes are prefixed with hotfix- Eg. hotfix-4.0.4
1919
* The original [GitFlow model](http://nvie.com/posts/a-successful-git-branching-model/)
2020
specifies branches with a "-" separator while the [git flow extensions](https://github.com/nvie/gitflow)
2121
default to a "/" separator. Either work with GitVersion.
22-
* Tags are used on the master branch and reflects the SemVer of each stable
22+
* Tags are used on the main branch and reflects the SemVer of each stable
2323
release eg 3.3.8 , 4.0.0, etc
2424
* Tags can also be used to override versions while we transition repositories
2525
over to GitVersion
@@ -34,9 +34,9 @@ will refer to:
3434
* `targetBranch` => the branch we are targeting
3535
* `targetCommit` => the commit we are targeting on `targetbranch`
3636

37-
### Master branch
37+
### Main branch
3838

39-
Commits on master will always be a merge commit (Either from a `hotfix` or a
39+
Commits on main will always be a merge commit (Either from a `hotfix` or a
4040
`release` branch) or a tag. As such we can simply take the commit message or tag
4141
message.
4242

@@ -62,15 +62,15 @@ Long version:
6262
### Develop branch
6363

6464
`targetCommitDate` => the date of the `targetCommit`
65-
`masterVersionCommit` => the first version (merge commit or SemVer tag) on
66-
`master` that is older than the `targetCommitDate`
67-
`masterMergeVersion` => the SemVer extracted from `masterVersionCommit.Message`
65+
`mainVersionCommit` => the first version (merge commit or SemVer tag) on
66+
`main` that is older than the `targetCommitDate`
67+
`mainMergeVersion` => the SemVer extracted from `mainVersionCommit.Message`
6868

69-
* major: `masterMergeVersion.Major`
70-
* minor: `masterMergeVersion.Minor + 1` (0 if the override above is used)
69+
* major: `mainMergeVersion.Major`
70+
* minor: `mainMergeVersion.Minor + 1` (0 if the override above is used)
7171
* patch: 0
7272
* pre-release: `alpha.{n}` where n = how many commits `develop` is in front of
73-
`masterVersionCommit.Date` ('0' padded to 4 characters)
73+
`mainVersionCommit.Date` ('0' padded to 4 characters)
7474

7575
Long version:
7676

@@ -97,7 +97,7 @@ Long version:
9797
### Release branches
9898

9999
* May branch off from: develop
100-
* Must merge back into: develop and master
100+
* Must merge back into: develop and main
101101
* Branch naming convention: `release-{n}` eg `release-1.2`
102102

103103
`releaseVersion` => the SemVer extracted from `targetBranch.Name`
@@ -125,14 +125,14 @@ Long version:
125125

126126
May branch off from: `develop`
127127
Must merge back into: `develop`
128-
Branch naming convention: anything except `master`, `develop`, `release-{n}`, or
128+
Branch naming convention: anything except `main`, `develop`, `release-{n}`, or
129129
`hotfix-{n}`.
130130

131131
TODO: feature branches cannot start with a SemVer. to stop people from create
132132
branches named like "4.0.3"
133133

134-
* major: `masterMergeVersion.Major`
135-
* minor: `masterMergeVersion.Minor + 1` (0 if the override above is used)
134+
* major: `mainMergeVersion.Major`
135+
* minor: `mainMergeVersion.Minor + 1` (0 if the override above is used)
136136
* patch: 0
137137
* pre-release: `alpha.feature-{n}` where n = First 8 characters of the commit
138138
SHA of the first commit
@@ -146,11 +146,11 @@ Long version:
146146

147147
May branch off from: `develop`
148148
Must merge back into: `develop`
149-
Branch naming convention: anything except `master`, `develop`, `release-{n}`, or
149+
Branch naming convention: anything except `main`, `develop`, `release-{n}`, or
150150
`hotfix-{n}`. Canonical branch name contains `/pull/`.
151151

152-
* major: `masterMergeVersion.Major`
153-
* minor: `masterMergeVersion.Minor + 1` (0 if the override above is used)
152+
* major: `mainMergeVersion.Major`
153+
* minor: `mainMergeVersion.Minor + 1` (0 if the override above is used)
154154
* patch: 0
155155
* pre-release: `alpha.pull{n}` where n = the pull request number ('0' padded to
156156
4 characters)

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Title: GitHubFlow Examples
1515

1616
Release branches can be used in GitHubFlow as well as GitFlow. Sometimes you
1717
want to start on a large feature which may take a while to stabilise so you want
18-
to keep it off master. In these scenarios you can either create a long lived
18+
to keep it off main. In these scenarios you can either create a long lived
1919
feature branch (if you do not know the version number this large feature will go
2020
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

0 commit comments

Comments
 (0)