Merge pull request #3246 from arturcic/feature/markdown-lint

Fix docs markdown lint errors

Author: arturcic

.github/workflows/ci.yml

@@ -136,6 +136,13 @@ jobs:
       matrix:
         os: [windows-latest, ubuntu-latest, macos-latest]
         targetFramework: [net48, net5.0, net6.0, netcoreapp3.1]
+        exclude:
+        -
+          os: 'ubuntu-latest'
+          targetFramework: net48
+        -
+          os: 'macos-latest'
+          targetFramework: net48
       fail-fast: false
 
     steps:

.github/workflows/docs.yml

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