Skip to content

Commit

Permalink
Squashed commit of the following:
Browse files Browse the repository at this point in the history
commit f76d8b8
Merge: f6d86dc 8c6175c
Author: Artur <arturcic@gmail.com>
Date:   Wed Oct 26 09:05:35 2022 +0200

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

    Fix docs markdown lint errors

commit 8c6175c
Author: Artur <arturcic@gmail.com>
Date:   Wed Oct 26 08:40:13 2022 +0200

    GitTools#2964 - disable tests for .net48

commit 21c34fb
Author: Artur <arturcic@gmail.com>
Date:   Wed Oct 26 02:07:16 2022 +0200

    GitTools#2964 - use bash for reporter

commit 93f4637
Author: Artur <arturcic@gmail.com>
Date:   Tue Oct 25 23:50:45 2022 +0200

    GitTools#2964 fix markdown linting errors

commit 18586fe
Author: Artur <arturcic@gmail.com>
Date:   Tue Oct 25 19:21:56 2022 +0200

    GitTools#2964 fix html-proofer errors

commit f6d86dc
Author: Artur <arturcic@gmail.com>
Date:   Tue Oct 25 16:15:45 2022 +0200

    (build) fix set-output syntax

    https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/

commit 2cc427c
Author: Artur <arturcic@gmail.com>
Date:   Tue Oct 25 15:25:27 2022 +0200

    Revert "(build) fix set-output syntax"

    This reverts commit b906175.

commit b812802
Author: Artur <arturcic@gmail.com>
Date:   Tue Oct 25 15:49:10 2022 +0200

    Revert "(build) fix set-output syntax"

    This reverts commit b07a8b9.

commit b07a8b9
Author: Artur <arturcic@gmail.com>
Date:   Tue Oct 25 15:49:10 2022 +0200

    (build) fix set-output syntax

    https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/

commit b906175
Author: Artur <arturcic@gmail.com>
Date:   Tue Oct 25 15:25:27 2022 +0200

    (build) fix set-output syntax

    https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/

commit 34f9de7
Author: Artur <arturcic@gmail.com>
Date:   Tue Oct 25 14:08:54 2022 +0200

    (build) update the actions/cache@v3.0.11

commit f954025
Author: Artur <arturcic@gmail.com>
Date:   Tue Oct 25 14:01:52 2022 +0200

    (build) update the actions/setup-dotnet@v3.0.2

commit 819f116
Merge: 8cd3a1b cac4eb1
Author: Artur <arturcic@gmail.com>
Date:   Tue Oct 25 13:26:41 2022 +0200

    Merge pull request GitTools#3179 from chhh/feature/report-project-file-location

    Add local project file location to exception when parsing fails

commit cac4eb1
Author: Dmitry Avtonomov <dmitry.avtononomov@bertis.com>
Date:   Fri Aug 26 13:38:47 2022 -0700

    Add local project file location to exception when parsing fails

    Helps in solutions with multiple projects, when one of csproj files
    becomes corrupt. User knows where to apply fixes.

commit 8cd3a1b
Merge: 3e5d1e7 1071e1c
Author: Asbjørn Ulsberg <asbjorn@ulsberg.no>
Date:   Tue Oct 25 11:26:26 2022 +0200

    Merge pull request GitTools#3208 from AlexPykavy/main

    Don't consider "tag-prefix" as optional if it's explicitly specified

commit 1071e1c
Author: Alexander Pykavy <aleksandrpykavyj@gmail.com>
Date:   Mon Sep 26 21:12:26 2022 +0200

    Don't consider "tag-prefix" as optional if it's explicitly specified

    To correctly calculate the next version with the prefix.

    For example, we develop the main product and some its plugin
    in the same repository and have the following git tags list:
    - 0.1.0
    - 0.1.1
    - 0.2.0
    - 0.2.1
    - plugin_0.1.0
    - plugin_0.1.1

    The expected next plugin version is `0.1.2` not `0.2.2` (`plugin_` prefix
    will be prepended before setting the tag).
  • Loading branch information
RatserX committed Nov 3, 2022
1 parent c8febc5 commit 1ec297a
Show file tree
Hide file tree
Showing 43 changed files with 634 additions and 575 deletions.
29 changes: 18 additions & 11 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,14 @@ jobs:
strategy:
matrix:
os: [windows-latest, ubuntu-latest, macos-latest]
targetFramework: [net7.0, net6.0]
targetFramework: [net48, net5.0, net6.0, netcoreapp3.1]
exclude:
-
os: 'ubuntu-latest'
targetFramework: net48
-
os: 'macos-latest'
targetFramework: net48
fail-fast: false

steps:
Expand Down Expand Up @@ -169,12 +176,12 @@ jobs:
shell: pwsh
run: dotnet run/build.dll --target=Test --dotnet_target=${{ matrix.targetFramework }}

-
name: Test Summary
uses: test-summary/action@v2
with:
paths: artifacts/test-results/*.results.xml
if: always()
# -
# name: Test Summary
# uses: test-summary/action@v1
# with:
# paths: artifacts/test-results/*.results.xml
# if: always()

artifacts_windows_test:
name: Test artifacts on windows
Expand Down Expand Up @@ -228,8 +235,8 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
targetFramework: [ '7.0', '6.0' ]
distro: [ alpine.3.13, alpine.3.14, centos.7, centos.8, debian.10, debian.11, fedora.33, ubuntu.18.04, ubuntu.20.04, ubuntu.22.04 ]
targetFramework: [ '3.1', '5.0', '6.0' ]
distro: [ alpine.3.12, alpine.3.13, alpine.3.14, centos.7, centos.8, debian.9, debian.10, debian.11, fedora.33, ubuntu.18.04, ubuntu.20.04 ]
fail-fast: false

steps:
Expand Down Expand Up @@ -293,8 +300,8 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
targetFramework: [ '7.0', '6.0' ]
distro: [ alpine.3.13, alpine.3.14, centos.7, centos.8, debian.10, debian.11, fedora.33, ubuntu.18.04, ubuntu.20.04, ubuntu.22.04 ]
targetFramework: [ '3.1', '5.0', '6.0' ]
distro: [ alpine.3.12, alpine.3.13, alpine.3.14, centos.7, centos.8, debian.9, debian.10, debian.11, fedora.33, ubuntu.18.04, ubuntu.20.04 ]
fail-fast: false

steps:
Expand Down
17 changes: 9 additions & 8 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions .remarkrc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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] |
Expand Down
14 changes: 7 additions & 7 deletions SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
4 changes: 1 addition & 3 deletions build/nuspec/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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/
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
18 changes: 8 additions & 10 deletions docs/input/docs/learn/branching-strategies/gitflow/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -58,7 +56,7 @@ Optional Tags (only when transitioning existing repository):

Long version:

```
```txt
{major}.{minor}.{patch} Sha:'{sha}'
1.2.3 Sha:'a682956dccae752aa24597a0f5cd939f93614509'
```
Expand All @@ -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'
```
Expand All @@ -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'
```
Expand Down Expand Up @@ -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'
Expand All @@ -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'
```
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/)
6 changes: 3 additions & 3 deletions docs/input/docs/learn/credits.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/
Expand Down
2 changes: 1 addition & 1 deletion docs/input/docs/learn/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
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
Loading

0 comments on commit 1ec297a

Please sign in to comment.