Skip to content

Commit

Permalink
GitTools#2964 fix html-proofer errors
Browse files Browse the repository at this point in the history
  • Loading branch information
arturcic committed Oct 25, 2022
1 parent f6d86dc commit 18586fe
Show file tree
Hide file tree
Showing 16 changed files with 35 additions and 42 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ jobs:
uses: chabad360/htmlproofer@master
with:
directory: ./artifacts/docs/preview
arguments: --url-ignore /api/ --allow-hash-href --assume-extension --disable-external
arguments: --ignore-urls /api/,/docs/ --allow-hash-href --assume-extension --disable-external
-
name: Reviewdog Reporter
uses: haya14busa/action-cond@v1
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,8 @@ The examples are generated by GitVersion tests, there are a number of services
which will then turn the sequence diagram text into an image to use in the docs.
Here are some links which could be useful

* [PlantUML Sequence Diagrams](http://www.plantuml.com/sequence.html)
* [CodeUML Online editor](http://www.codeuml.com/)
* [PlantText Online editor](http://www.planttext.com/planttext)
* [PlantUML gist renderer](http://uml.mvnsearch.org)
* [PlantUML Sequence Diagrams](https://www.plantuml.com/sequence.html)
* [PlantText Online editor](https://www.planttext.com)

The tests are quite simple. Using the methods on the `fixture` itself will
record that action in the sequence diagram. If you do not want the action
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -87,10 +87,6 @@ patch _will not_ automatically bump, meaning you have to use hotfix branches.

See [contributing examples](/docs/learn/branching-strategies/contribute-examples).

## Complete Example

![GitFlow](http://uml.mvnsearch.org/gist/cf053d7f5d336ae9f7bb)

### Source

See `DocumentationSamples.GitFlowExample`. To update, modify then run test.
Expand Down
6 changes: 3 additions & 3 deletions docs/input/docs/learn/branching-strategies/gitflow/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ SemVer compatible versions from this structure.

## Assumptions:

* Using [GitFlow branching model](http://nvie.com/git-model/) which always has a
* Using [GitFlow branching model](https://nvie.com/git-model/) which always has a
main and a develop branch
* Following [Semantic Versioning](http://semver.org/)
* Following [Semantic Versioning](https://semver.org/)
* Planned releases (bumps in major or minor) are done on release branches
prefixed with release-. Eg: release-4.1 (or release-4.1.0)
* Hotfixes are prefixed with hotfix- Eg. hotfix-4.0.4
* The original [GitFlow model](http://nvie.com/posts/a-successful-git-branching-model/)
* The original [GitFlow model](https://nvie.com/posts/a-successful-git-branching-model/)
specifies branches with a "-" separator while the [git flow extensions](https://github.com/nvie/gitflow)
default to a "/" separator. Either work with GitVersion.
* Tags are used on the main branch and reflects the SemVer of each stable
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ RedirectFrom: docs/git-branching-strategies/githubflow-examples
## Release branch

Release branches can be used in GitHubFlow as well as GitFlow. Sometimes you
want to start on a large feature which may take a while to stabilise so you want
want to start on a large feature which may take a while to stabilize so you want
to keep it off main. In these scenarios you can either create a long lived
feature branch (if you do not know the version number this large feature will go
into, and it's non-breaking) otherwise you can create a release branch for the
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ GitHub Flow allows and encourages [continuous delivery](/docs/reference/modes/co

## Resources

* [GitHubFlow guide by GitHub](https://guides.github.com/introduction/flow/index.html)
* [GitHubFlow original blog post](http://scottchacon.com/2011/08/31/github-flow.html)
* [Phil Haack's (haacked) GitHubFlow aliases](http://haacked.com/archive/2014/07/28/github-flow-aliases/)
* [GitHubFlow vs GitFlow](http://lucamezzalira.com/2014/03/10/git-flow-vs-github-flow/)
* [GitHubFlow guide by GitHub](https://docs.github.com/en/get-started/quickstart/github-flow#introduction)
* [GitHubFlow original blog post](https://scottchacon.com/2011/08/31/github-flow.html)
* [Phil Haack's (haacked) GitHubFlow aliases](https://haacked.com/archive/2014/07/28/github-flow-aliases/)
* [GitHubFlow vs GitFlow](https://lucamezzalira.com/2014/03/10/git-flow-vs-github-flow/)
4 changes: 2 additions & 2 deletions docs/input/docs/learn/how-it-works.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ GitVersion has three distinct steps for calculating versions in v3.

Visually it looks something like this:

![Version Calculation](http://www.plantuml.com:80/plantuml/png/fLCxJyCm4DxzAsuib4P914i69De1CS38Vd6kYIN7ZcodK8aVp-KX6Y2fKCbY9NV-7lVb2WoOeoVOMRDNfH0lz1vUoNbbpGwrR3K6ws1p3rlk-bN8u972f2AC3GHEbLN8m1D1Jjg-mPuXAZvx9kL1ZW1KY5dOZczMI0Pf54VnHtf7jpaAWJg0sW-uXw4PK3Eb1sMaevfCW6i1\_0m6po1l7HfPJUxvu5XYUOHLWq5MLptCudmMK9--u5glJ0dIEaVo1Dw3JgVM6Km4cM9mzyrQXHuQHnj7chhl0JcnIrHjno1wiWtgfi8eWVK\_7OQAmBHrJWvORFVM2PmrE7AcWZGh-Lj0FvptVvLiUPnCdG_XhNhOov9wQ1fzv7nw5S5EwSvw6CDQNfnMwUAP0XQyQpj70nkx3Nn3p5NFY9IshbNWepKi8ublWFiSPkC0ee8El75Dv5aOxqZQBScbWpWn0Pe2wb6aM1p4Eea\_0G00)
![Version Calculation](https://www.plantuml.com/plantuml/png/fLCxJyCm4DxzAsuib4P914i69De1CS38Vd6kYIN7ZcodK8aVp-KX6Y2fKCbY9NV-7lVb2WoOeoVOMRDNfH0lz1vUoNbbpGwrR3K6ws1p3rlk-bN8u972f2AC3GHEbLN8m1D1Jjg-mPuXAZvx9kL1ZW1KY5dOZczMI0Pf54VnHtf7jpaAWJg0sW-uXw4PK3Eb1sMaevfCW6i1\_0m6po1l7HfPJUxvu5XYUOHLWq5MLptCudmMK9--u5glJ0dIEaVo1Dw3JgVM6Km4cM9mzyrQXHuQHnj7chhl0JcnIrHjno1wiWtgfi8eWVK\_7OQAmBHrJWvORFVM2PmrE7AcWZGh-Lj0FvptVvLiUPnCdG_XhNhOov9wQ1fzv7nw5S5EwSvw6CDQNfnMwUAP0XQyQpj70nkx3Nn3p5NFY9IshbNWepKi8ublWFiSPkC0ee8El75Dv5aOxqZQBScbWpWn0Pe2wb6aM1p4Eea\_0G00)

[Edit Diagram](http://www.plantuml.com/plantuml/form?url=http://www.plantuml.com/plantuml/png/fLCxJyCm4DxzAsuib4P914i69De1CS38Vd6kYIN7ZcodK8aVp-KX6Y2fKCbY9NV-7lVb2WoOeoVOMRDNfH0lz1vUoNbbpGwrR3K6ws1p3rlk-bN8u972f2AC3GHEbLN8m1D1Jjg-mPuXAZvx9kL1ZW1KY5dOZczMI0Pf54VnHtf7jpaAWJg0sW-uXw4PK3Eb1sMaevfCW6i1\_0m6po1l7HfPJUxvu5XYUOHLWq5MLptCudmMK9--u5glJ0dIEaVo1Dw3JgVM6Km4cM9mzyrQXHuQHnj7chhl0JcnIrHjno1wiWtgfi8eWVK\_7OQAmBHrJWvORFVM2PmrE7AcWZGh-Lj0FvptVvLiUPnCdG_XhNhOov9wQ1fzv7nw5S5EwSvw6CDQNfnMwUAP0XQyQpj70nkx3Nn3p5NFY9IshbNWepKi8ublWFiSPkC0ee8El75Dv5aOxqZQBScbWpWn0Pe2wb6aM1p4Eea\_0G00)
[Edit Diagram](https://www.plantuml.com/plantuml/form?url=https://www.plantuml.com/plantuml/png/fLCxJyCm4DxzAsuib4P914i69De1CS38Vd6kYIN7ZcodK8aVp-KX6Y2fKCbY9NV-7lVb2WoOeoVOMRDNfH0lz1vUoNbbpGwrR3K6ws1p3rlk-bN8u972f2AC3GHEbLN8m1D1Jjg-mPuXAZvx9kL1ZW1KY5dOZczMI0Pf54VnHtf7jpaAWJg0sW-uXw4PK3Eb1sMaevfCW6i1\_0m6po1l7HfPJUxvu5XYUOHLWq5MLptCudmMK9--u5glJ0dIEaVo1Dw3JgVM6Km4cM9mzyrQXHuQHnj7chhl0JcnIrHjno1wiWtgfi8eWVK\_7OQAmBHrJWvORFVM2PmrE7AcWZGh-Lj0FvptVvLiUPnCdG_XhNhOov9wQ1fzv7nw5S5EwSvw6CDQNfnMwUAP0XQyQpj70nkx3Nn3p5NFY9IshbNWepKi8ublWFiSPkC0ee8El75Dv5aOxqZQBScbWpWn0Pe2wb6aM1p4Eea\_0G00)

**\*** Some strategies allow the version to be incremented, others don't. More
info below.
Expand Down
6 changes: 3 additions & 3 deletions docs/input/docs/learn/intro-to-semver.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Title: Intro to SemVer
RedirectFrom: docs/reference/intro-to-semver
---

For the official Semantic Version docs head to [semver.org](http://semver.org). This is just a quick guide for people getting started and how SemVer is used in GitVersion.
For the official Semantic Version docs head to [semver.org](https://semver.org). This is just a quick guide for people getting started and how SemVer is used in GitVersion.

## Why SemVer?

Expand All @@ -25,10 +25,10 @@ SemVer introduces conventions about breaking changes into our version numbers so

Only one number should be incremented per release, and all lower parts should be reset to 0 (if `{major}` is incremented, then `{minor}` and `{patch}` should become 0).

For a more complete explanation check out [semver.org](http://semver.org) which is the official spec. Remember this is a brief introduction and does not cover all parts of semantic versioning, just the important parts to get started.
For a more complete explanation check out [semver.org](https://semver.org) which is the official spec. Remember this is a brief introduction and does not cover all parts of semantic versioning, just the important parts to get started.

## SemVer in GitVersion

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_.
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://docs.github.com/en/get-started/quickstart/github-flow#introduction) will bump the _patch_.

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}`
1 change: 0 additions & 1 deletion docs/input/docs/learn/who.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ that we know about today.
* [NUKE](https://nuke.build)
* [Orc.\* packages](https://github.com/wildgums?query=orc)
* [Orchestra](https://github.com/wildgums/orchestra)
* [Pomona](http://pomona.io/)
* [Shouldly](https://github.com/shouldly/shouldly)
* [Akavache](https://github.com/akavache/akavache)
* [Splat](https://github.com/paulcbetts/splat)
Expand Down
10 changes: 5 additions & 5 deletions docs/input/docs/reference/build-servers/azure-devops.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ the MS Build Task.
5. If you want the GitVersionTask to update AssemblyInfo files add
`updateAssemblyInfo true` to the Arguments parameter.
6. If you want to update the build number you need to send a
[logging command](https://github.com/Microsoft/azure-pipelines-tasks/blob/main/docs/authoring/commands.md)
[logging command](https://github.com/microsoft/azure-pipelines-tasks/blob/main/docs/authoring/commands.md)
to TFS.

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

1. Install the `tfx` command line tool as shown [here](https://github.com/Microsoft/tfs-cli/blob/main/README.md#install).
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).
1. Install the `tfx` command line tool as shown [here](https://github.com/microsoft/tfs-cli/blob/master/README.md#setup).
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).
3. Download the GitVersion TFS build task from the latest release on the
[GitVersion releases page](https://github.com/GitTools/GitVersion/releases) and
unzip.
4. Run `tfx login` as shown [here](https://github.com/Microsoft/tfs-cli/blob/main/README.md#login).
4. Run `tfx login` as shown [here](https://github.com/microsoft/tfs-cli/blob/master/README.md#login).
5. From the directory outside of where you unzipped the task, run
`tfx build tasks upload --task-path .\GitVersionVsixTask --overwrite` where
GitVersionVsixTask is the directory containing the files.
Expand Down Expand Up @@ -166,7 +166,7 @@ variables.
build but makes sure that all tags are fetched. In the future it is planned to
allow using `git.exe` instead of current `libgit2sharp` for syncing the repos
which might allow other possibilities to solve this issue. For details see this
[GitHub issue](https://github.com/Microsoft/azure-pipelines-tasks/issues/1218).
[GitHub issue](https://github.com/microsoft/azure-pipelines-tasks/issues/1218).
* If running a build for a certain commit (through passing the commit SHA while
queueing the build) all tags from the repository will be fetched, even the ones
newer than the commit. This can lead to different version numbers while
Expand Down
8 changes: 4 additions & 4 deletions docs/input/docs/reference/build-servers/myget.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,16 @@ RedirectFrom: docs/build-server-support/build-server/myget
MyGet Build Services has built-in support for GitVersion and is encouraging you
to leverage GitVersion + GitFlow to produce Semantically Versioned packages.

* Create a [custom build script](http://docs.myget.org/docs/reference/custom-build-scripts):
* Create a [custom build script](https://docs.myget.org/docs/reference/custom-build-scripts):
we advise to run a tool like GitVersion in a _pre-build_ script, so that it can
set additional environment variables for the actual build script. MyGet
[by convention](http://docs.myget.org/docs/reference/build-services#Pre-\_and_post-build_steps)
[by convention](https://docs.myget.org/docs/reference/build-services#Pre-\_and_post-build_steps)
automatically picks up any of the following file names as pre-build script:
* `pre-build.(bat|cmd|ps1)`
* `pre-myget.(bat|cmd|ps1)`
* Run `GitVersion /output buildserver`: this will cause MyGet Build Services to
set the current `%PackageVersion%` value to the NuGet-compatible SemVer
generated by GitVersion and apply this [MyGet Environment Variable](http://docs.myget.org/docs/reference/build-services#Available_Environment_Variables)
generated by GitVersion and apply this [MyGet Environment Variable](https://docs.myget.org/docs/reference/build-services#Available_Environment_Variables)
wherever it is used during the build process.
* Ensure the build script has been pushed to your source repository root. Done :)

Expand All @@ -31,5 +31,5 @@ example using the command:
`call %GitVersion% /updateassemblyinfo true`.
:::

Also check [docs.myget.org](http://docs.myget.org/docs/reference/build-services#GitVersion_and_Semantic_Versioning)
Also check [docs.myget.org](https://docs.myget.org/docs/reference/build-services#GitVersion_and_Semantic_Versioning)
for the latest full info.
6 changes: 3 additions & 3 deletions docs/input/docs/reference/build-servers/teamcity.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,9 +104,9 @@ Sorry

* [Continuous Delivery Setup in TeamCity][cd]

[cd]: http://jake.ginnivan.net/blog/2014/07/09/my-typical-teamcity-build-setup
[cd]: https://jake.ginnivan.net/blog/2014/07/09/my-typical-teamcity-build-setup
[dynamic-repo]: /docs/learn/dynamic-repositories
[general-settings]: https://www.jetbrains.com/help/teamcity/git.html#Git-GeneralSettings
[parameter]: http://confluence.jetbrains.com/display/TCD8/Configuring+Build+Parameters
[general-settings]: https://www.jetbrains.com/help/teamcity/git.html#General+Settings
[parameter]: https://confluence.jetbrains.com/display/TCD8/Configuring+Build+Parameters
[teamcity]: https://www.jetbrains.com/teamcity/
[meta-runner]: https://github.com/JetBrains/meta-runner-power-pack/tree/master/gitversion
4 changes: 2 additions & 2 deletions docs/input/docs/reference/modes/continuous-delivery.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,8 @@ an external manual process.
* [Continuous Delivery on Wikipedia][wikipedia]
* [Continuous Delivery, the book][book]
[book]: http://www.amazon.com/Continuous-Delivery-Deployment-Automation-Addison-Wesley/dp/0321601912
[book]: https://www.amazon.com/Continuous-Delivery-Deployment-Automation-Addison-Wesley/dp/0321601912
[configuration]: /docs/reference/configuration
[continuous-deployment]: continuous-deployment
[continuous-deployment]: /docs/reference/modes/continuous-deployment
[mainline]: /docs/reference/modes/mainline
[wikipedia]: https://en.wikipedia.org/wiki/Continuous_delivery
2 changes: 1 addition & 1 deletion docs/input/docs/reference/modes/continuous-deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ giving you the features of GitVersion with continuous deployment:
mode: ContinuousDeployment
```
[blog]: http://www.xavierdecoster.com/semantic-versioning-auto-incremented-nuget-package-versions
[blog]: https://www.xavierdecoster.com/semantic-versioning-auto-incremented-nuget-package-versions
[configuration]: /docs/reference/configuration
[continuous-delivery]: /docs/reference/modes/continuous-delivery
[mainline]: /docs/reference/modes/mainline
2 changes: 1 addition & 1 deletion docs/input/docs/reference/version-increments.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ will produce a stable `2.0.0` package.
For more information/background on why we have come to this conclusion, read
[Xavier Decoster's blog post on the subject][auto-incremented-nuget-package].

[auto-incremented-nuget-package]: http://www.xavierdecoster.com/semantic-versioning-auto-incremented-nuget-package-versions
[auto-incremented-nuget-package]: https://www.xavierdecoster.com/semantic-versioning-auto-incremented-nuget-package-versions
[continuous-delivery]: /docs/reference/modes/continuous-delivery
[conventional-commits]: https://www.conventionalcommits.org/
[faq-branch-name-source]: /docs/learn/faq#merged-branch-names-as-version-source
6 changes: 3 additions & 3 deletions docs/input/docs/usage/cli/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ of writing: Linux and macOS).

### Chocolatey

Available on [Chocolatey](http://chocolatey.org) as
Available on [Chocolatey](https://chocolatey.org) as
[`GitVersion.Portable`][choco].

```shell
Expand Down Expand Up @@ -84,7 +84,7 @@ of writing: Linux, macOS, Windows).

[dotnet-tool]: https://docs.microsoft.com/en-us/dotnet/core/tools/global-tools#install-a-global-tool
[tool]: https://www.nuget.org/packages/GitVersion.Tool/
[brew]: https://formulae.brew.sh/formula-linux/gitversion
[brew]: https://formulae.brew.sh/formula/gitversion
[homebrew]: https://brew.sh/
[docker]: https://hub.docker.com/r/gittools/gitversion
[choco]: http://chocolatey.org/packages/GitVersion.Portable
[choco]: https://chocolatey.org/packages/GitVersion.Portable

0 comments on commit 18586fe

Please sign in to comment.