Merge branch 'support/5.x' into main

.github/workflows/docs.yml

@@ -58,8 +58,11 @@ jobs:
         key: tools-${{ runner.os }}-${{ hashFiles('./build/**') }}
     -
       name: Get npm cache directory
+      shell: bash
       id: cache-node-dir
-      run: echo "::set-output name=dir::$(npm config get cache)"
+      run: |
+        cacheDir=$(npm config get cache)
+        echo "dir=$cacheDir" >> $GITHUB_OUTPUT
     -
       name: Cache Node Modules
       id: cache-node
@@ -118,15 +121,13 @@ 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
+      name: '[Reviewdog Reporter]'
       id: reporter
-      with:
-        cond: ${{ github.event_name == 'pull_request' }}
-        if_true: github-pr-review
-        if_false: github-check
+      run: |
+        value=$([ ${{ github.event_name == 'pull_request' }} ] && echo "github-pr-review" || echo "github-check")
+        echo "value=$value" >> $GITHUB_OUTPUT
     -
       name: '[Remark Lint]'
       uses: reviewdog/action-remark-lint@v5.6

.remarkrc.yaml

@@ -25,12 +25,12 @@ plugins:
   - remark-lint-no-blockquote-without-marker
   - remark-lint-no-consecutive-blank-lines
   - remark-lint-no-duplicate-definitions
-  - remark-lint-no-duplicate-headings
+  - remark-lint-no-duplicate-headings: ["warn"]
   - remark-lint-no-emphasis-as-heading
   - remark-lint-no-empty-url
   - remark-lint-no-file-name-articles
   - remark-lint-no-file-name-consecutive-dashes
-  - remark-lint-no-file-name-irregular-characters
+  - remark-lint-no-file-name-irregular-characters: ["warn"]
   - remark-lint-no-file-name-mixed-case
   - remark-lint-no-file-name-outer-dashes
   - remark-lint-no-heading-content-indent

README.md

@@ -14,7 +14,7 @@ works out the [Semantic Version][semver] of the commit being built.
 | **GitVersion.Portable**    |                     [![Chocolatey][choco-badge]][choco]            |
 | **GitVersion.Tool**        |                           [![NuGet][gvgt-badge]][gvgt]             |
 | **GitVersion.CommandLine** |                           [![NuGet][gvcl-badge]][gvcl]             |
-| **GitVersion.MsBuild**     |                            [![NuGet][gvt-badge]][gvt]              | Known as [GitVersionTask] before v5.6.0 |
+| **GitVersion.MsBuild**     |                            [![NuGet][gvt-badge]][gvt]              | Known as [GitVersionTask][gitversiontask] before v5.6.0 |
 | **Homebrew**               |                        [![homebrew][brew-badge]][brew]             |
 | **Azure Pipeline Task**    | [![Azure Pipeline Task][az-pipeline-task-badge]][az-pipeline-task] |
 | **Github Action**          |             [![Github Action][gh-actions-badge]][gh-actions]       |

SECURITY.md

@@ -17,13 +17,13 @@ You should receive a response within 24 hours. If for some reason you do not, pl
 
 Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:
 
-  * Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
-  * Full paths of source file(s) related to the manifestation of the issue
-  * The location of the affected source code (tag/branch/commit or direct URL)
-  * Any special configuration required to reproduce the issue
-  * Step-by-step instructions to reproduce the issue
-  * Proof-of-concept or exploit code (if possible)
-  * Impact of the issue, including how an attacker might exploit the issue
+*   Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
+*   Full paths of source file(s) related to the manifestation of the issue
+*   The location of the affected source code (tag/branch/commit or direct URL)
+*   Any special configuration required to reproduce the issue
+*   Step-by-step instructions to reproduce the issue
+*   Proof-of-concept or exploit code (if possible)
+*   Impact of the issue, including how an attacker might exploit the issue
 
 This information will help us triage your report more quickly.
 

build/nuspec/README.md

@@ -9,7 +9,7 @@ works out the [Semantic Version][semver] of the commit being built.
 | :------------------------- | :----------------------------------------------------------------- | - |
 | **GitVersion.Tool**        |                           [![NuGet][gvgt-badge]][gvgt]             |
 | **GitVersion.CommandLine** |                           [![NuGet][gvcl-badge]][gvcl]             |
-| **GitVersion.MsBuild**     |                            [![NuGet][gvt-badge]][gvt]              | Known as [GitVersionTask] before v5.6.0 |
+| **GitVersion.MsBuild**     |                            [![NuGet][gvt-badge]][gvt]              | Known as [GitVersionTask][gitversiontask] before v5.6.0 |
 
 ## Compatibility
 
@@ -44,8 +44,6 @@ from The Noun Project.
 [gitter]:                          https://gitter.im/GitTools/GitVersion?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
 [gitter-badge]:                    https://badges.gitter.im/Join+Chat.svg
 [docs]:                            https://gitversion.net/docs/
-[gh-rel]:                          https://github.com/GitTools/GitVersion/releases/latest
-[gh-rel-badge]:                    https://img.shields.io/github/release/gittools/gitversion.svg?logo=github
 [gvt]:                             https://www.nuget.org/packages/GitVersion.MsBuild
 [gvt-badge]:                       https://img.shields.io/nuget/v/GitVersion.MsBuild.svg?logo=nuget
 [gitversiontask]:                  https://www.nuget.org/packages/GitVersionTask/

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

@@ -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

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

@@ -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.

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

@@ -8,17 +8,15 @@ RedirectFrom: docs/git-branching-strategies/gitflow
 Git Flow allows more structured releases, and GitVersion will derive sensible
 SemVer compatible versions from this structure.
 
-## Resources
-
 ## 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
@@ -58,7 +56,7 @@ Optional Tags (only when transitioning existing repository):
 
 Long version:
 
-```
+```txt
 {major}.{minor}.{patch} Sha:'{sha}'
 1.2.3 Sha:'a682956dccae752aa24597a0f5cd939f93614509'
 ```
@@ -78,7 +76,7 @@ Long version:
 
 Long version:
 
-```
+```txt
 {major}.{minor}.{patch}-{pre-release} Branch:'{branchName}' Sha:'{sha}'
 1.2.3-alpha.645 Branch:'develop' Sha:'a682956dccae752aa24597a0f5cd939f93614509'
 ```
@@ -97,7 +95,7 @@ Named: `hotfix-{versionNumber}` eg `hotfix-1.2`
 
 Long version:
 
-```
+```txt
 {major}.{minor}.{patch}-{pre-release} Branch:'{branchName}' Sha:'{sha}'
 1.2.3-beta645 Branch:'hotfix-foo' Sha:'a682956dccae752aa24597a0f5cd939f93614509'
 ```
@@ -125,7 +123,7 @@ that tag the version would be `1.2.0-alpha1.4`
 
 Long version:
 
-```
+```txt
 {major}.{minor}.{patch}-{pre-release} Branch:'{branchName}' Sha:'{sha}'
 1.2.3-alpha2.4 Branch:'release-1.2' Sha:'a682956dccae752aa24597a0f5cd939f93614509'
 1.2.3-rc2 Branch:'release-1.2' Sha:'a682956dccae752aa24597a0f5cd939f93614509'
@@ -149,7 +147,7 @@ branches named like "4.0.3"
 
 Long version:
 
-```
+```txt
 {major}.{minor}.{patch}-{pre-release} Branch:'{branchName}' Sha:'{sha}'
 1.2.3-alpha.feature-a682956d Branch:'feature1' Sha:'a682956dccae752aa24597a0f5cd939f93614509'
 ```

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

@@ -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

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

@@ -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/)

docs/input/docs/learn/credits.md

@@ -9,13 +9,13 @@ Icons sourced, with love, from [The Noun Project][the-noun-project]:
 |                     Icon                    | Designer                                                   |
 | :-----------------------------------------: | :--------------------------------------------------------- |
 |       [![Tree][tree-icon]][tree-link]       | [Tree][tree-link] by [Davic Chapman][david-chapman]        |
-|    [![Repeat][repeat-icon]][repeat-link]    | [Repeat][repeat-link] by [Arthur Shlain][artZ91]           |
-| [![Terminal][terminal-icon]][terminal-link] | [Terminal][terminal-link] by [Ghayn]                       |
+|    [![Repeat][repeat-icon]][repeat-link]    | [Repeat][repeat-link] by [Arthur Shlain][artz91]           |
+| [![Terminal][terminal-icon]][terminal-link] | [Terminal][terminal-link] by [Ghayn][ghayn]                |
 |   [![Collect][collect-icon]][collect-link]  | [Collect][collect-link] by [Shmidt Sergey][monstercritic]  |
 |   [![Library][library-icon]][library-link]  | [Library][library-link] by [Kevin Eichhorn][kevineichhorn] |
 :::
 
-[artZ91]: https://thenounproject.com/ArtZ91/
+[artz91]: https://thenounproject.com/ArtZ91/
 [collect-icon]: /assets/img/collect.svg
 [collect-link]: https://thenounproject.com/term/collect/424422/
 [david-chapman]: https://thenounproject.com/david.chapman/

docs/input/docs/learn/faq.md

@@ -30,7 +30,7 @@ be a good primer to read before reading [SemVer.org][semver].
 ## I can't use the build number for NuGet
 
 If you have used NuGet you would notice the versions above are not compatible
-with NuGet. GitVersion solves this by providing [variables].
+with NuGet. GitVersion solves this by providing [variables][variables].
 
 What you have seen above is the `SemVer` variable. You can use the
 `NuGetVersion` variable to have the version formatted in a NuGet compatible way.

docs/input/docs/learn/how-it-works.md

@@ -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.

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

@@ -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?
 
@@ -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}`

docs/input/docs/learn/who.md

@@ -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)