Versionize 1.7.0
See the version list below for details.
dotnet tool install --global Versionize --version 1.7.0
dotnet new tool-manifest # if you are setting up this repo dotnet tool install --local Versionize --version 1.7.0
#tool dotnet:?package=Versionize&version=1.7.0
nuke :add-package Versionize --version 1.7.0
Versionize
stop using weird build scripts to increment your nuget's version, use
versionize
!
Automatic versioning and CHANGELOG generation, using conventional commit messages.
how it works:
- when you land commits on your
master
branch, select the Squash and Merge option (not required). - add a title and body that follows the Conventional Commits Specification.
- when you're ready to release a nuget package:
git checkout master; git pull origin master
- run
versionize
git push --follow-tags origin master
dotnet pack
dotnet nuget push
versionize
does the following:
- bumps the version in your
.csproj
file (based on your commit history) - uses conventional-changelog to update CHANGELOG.md
- commits
.csproj
file and CHANGELOG.md - tags a new release
Installation
dotnet tool install --global Versionize
Usage
Usage: versionize [options]
Options:
-?|-h|--help Show help information
-v|--version Show version information
-w|--workingDir <WORKING_DIRECTORY> Directory containing projects to version
-d|--dry-run Skip changing versions in projects, changelog generation and git commit
--skip-dirty Skip git dirty check
-r|--release-as <VERSION> Specify the release version manually
--silent Suppress output to console
--skip-commit Skip commit and git tag after updating changelog and incrementing the version
-i|--ignore-insignificant-commits Do not bump the version if no significant commits (fix, feat or BREAKING) are found
--changelog-all Include all commits in the changelog not just fix, feat and breaking changes
--commit-suffix Suffix to be added to the end of the release commit message (e.g. [skip ci])
Supported commit types
Every commit should be in the form
<type>[optional scope]: <description>
for example
fix(parser): remove colon from type and scope
- fix - will trigger a patch version increment in the next release
- feat - will trigger a minor version increment in the next release
- all other types - you can use any commit type but that commit type will not trigger a version increment in the next release
Breaking changes must contain a line prefixed with BREAKING CHANGE:
to allow versionize recognizing a breaking change. Breaking changes can use any commit type.
Example
git commit -m "chore: update dependencies" -m "BREAKING CHANGE: this will likely break the interface"
The happy versioning walkthrough
Preparation
Create a new project with the dotnet cli
mkdir SomeProject
dotnet new classlib
Ensure that a <Version> element is contained in file SomeProject.csproj
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<Version>1.0.0</Version>
</PropertyGroup>
</Project>
Using versionize
Now let's start committing and releasing
git init
...make some changes to "Class1.cs"
git add *
git commit -a -m "chore: initial commit"
versionize
Will add a CHANGELOG.md, add git tags and commit everything. Note that the version in SomeProject.csproj
will not change since this is your first release with versionize
.
...make some changes to "Class1.cs"
git commit -a -m "fix: something went wrong we need a bugfix release"
versionize
Will update CHANGELOG.md, add git tags and commit everything. Note that the version in SomeProject.csproj
is now 1.0.1
.
...make some changes to "Class1.cs"
git commit -a -m "feat: something really awesome coming in the next release"
versionize
Will update CHANGELOG.md, add git tags and commit everything. Note that the version in SomeProject.csproj
is now 1.1.0
.
...make some changes to "Class1.cs"
git commit -a -m "feat: a really cool new feature" -m "BREAKING CHANGE: the API will break. sorry"
versionize
Will update CHANGELOG.md, add git tags and commit everything. Note that the version in SomeProject.csproj
is now 2.0.0
since
versionize detected a breaking change since the commit note BREAKING CHANGE
was used above.
Developing
To get prettier test outputs run dotnet test
with prettier test logger
dotnet test --logger prettier
Roadmap
- Pre Releases to allow creating beta.1, beta.2 versions
- Support .versionrc like "standard-version" does
- Support mono repo joint and disjoint version strategies
-
--silent command line switch to suppress commandline output -
-i
,--ignore-insignificant-commits
command line switch to not create a new version if only insignificant (chore, ...) commits were done - GitHub URLs in changelog
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 is compatible. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
.NET Core | netcoreapp2.1 is compatible. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 is compatible. |
This package has no dependencies.
Version | Downloads | Last updated |
---|---|---|
2.0.0 | 0 | 10/15/2024 |
1.27.0 | 36,648 | 6/15/2024 |
1.26.2 | 241 | 6/15/2024 |
1.26.1 | 221 | 6/15/2024 |
1.26.0 | 216 | 6/15/2024 |
1.25.0 | 11,942 | 5/5/2024 |
1.24.0 | 2,590 | 4/30/2024 |
1.23.0 | 2,114 | 4/29/2024 |
1.22.0 | 19,344 | 3/2/2024 |
1.21.0 | 32,663 | 11/3/2023 |
1.20.0 | 3,156 | 10/27/2023 |
1.19.1 | 9,886 | 9/16/2023 |
1.19.0 | 1,368 | 9/16/2023 |
1.18.0 | 42,512 | 3/11/2023 |
1.17.1 | 3,464 | 2/8/2023 |
1.17.0 | 4,838 | 12/23/2022 |
1.16.0 | 387 | 12/23/2022 |
1.15.2 | 6,804 | 10/4/2022 |
1.15.1 | 640 | 10/1/2022 |
1.15.0 | 32,959 | 6/26/2022 |
1.14.0 | 3,816 | 5/13/2022 |
1.13.0 | 1,320 | 3/13/2022 |
1.12.1 | 687 | 3/5/2022 |
1.12.0 | 552 | 2/26/2022 |
1.11.0 | 642 | 2/11/2022 |
1.10.0 | 622 | 1/5/2022 |
1.9.0 | 470 | 12/30/2021 |
1.8.0 | 3,620 | 10/5/2021 |
1.7.0 | 430 | 10/4/2021 |
1.6.2 | 3,384 | 1/9/2021 |
1.6.1 | 832 | 11/29/2020 |
1.6.0 | 616 | 11/29/2020 |
1.5.1 | 2,431 | 8/16/2020 |
1.4.0 | 577 | 8/11/2020 |
1.3.0 | 4,922 | 1/22/2020 |
1.2.0 | 1,513 | 12/18/2018 |
1.1.0 | 768 | 10/5/2018 |
1.0.0 | 816 | 9/29/2018 |