📝 NEW Open Source Maintenance Fee EULA

To ensure the long-term sustainability of this project, use of GitInfo requires an Open Source Maintenance Fee. While the source code is freely available under the terms of the MIT License, all other aspects of the project --including opening or commenting on issues, participating in discussions and downloading releases-- require adherence to the Maintenance Fee.

In short, if you use this project to generate revenue, the Maintenance Fee is required.

To pay the Maintenance Fee, become a Sponsor at the corresponding
OSMF tier (starting at just $10!).

Full Changelog: v3.5.0...v3.6.0

Sponsors

The following sponsors made this release possible: @clarius, @MFB-Technologies-Inc, @drivenet, @Keflon, @tbolon, @kfrancis, @unoplatform, @rbnswartz, @jfoshee, @Mrxx99, @eajhnsn1, @davidjenni, @Jonathan-Hickey, @akunzai, @KenBonny, @SimonCropp, @agileworks-eu, @arsdragonfly, @vezel-dev, @ChilliCream, @4OTC, @v-limo, @jordansjones, @DominicSchell, @jwendl, @adalon, @Eule02, @henkmartijn, @torutek, @mccaffers.

Thanks 💜

Full Changelog

:hammer: Other:

• Get error 'ThisAssembly' is inaccessible due to its protection level #377
• [FEAT] Add support for MSYS2 #374
• 💟 Adopting SponsorLink in v3.5 #369

:twisted_rightwards_arrows: Merged:

• Adopt OSMF EULA #386 (@kzu)

Starting in v3.5, GitInfo now adopts SponsorLink v2

Sponsor status (direct, indirect or implicit) is required for IDE usage.
IDE-only warnings will be issued otherwise. Learn more at https://github.com/devlooped#sponsorlink

What's Changed

✨ Implemented enhancements

• Using simpler git command to get current commit by @kzu in #356
• Set default GitBranch from CI env variables by @kzu in #365
• Allow opting-out of GitBranch default in CI by @kzu in #366
• Simplify IsDirty with newer typed constants in ThisAssembly by @kzu in #368
• Add vswhere fallback to locate git provided by VS by @kzu in #372

📝 Documentation updates

• Adopt SL v2 via ThisAssembly.Constants and document in readme(s) by @kzu in #370

🔨 Other

• Disable rogue command echo by @gitfool in #342
• Remove redundant depends on targets by @gitfool in #346
• Fix fast up-to-date-check by @gitfool in #343
• Clean code by @gitfool in #352

Full Changelog: v3.3.5...v3.5.0

What's Changed

🐛 Fixed bugs

• Do not emit ThisAssembly.Git.IsDirty when GitThisAssembly is false by @kzu in #338

Full Changelog: v3.3.4...v3.3.5

What's Changed

🔨 Other

• Fix race conditions by @gitfool in #330

New Contributors

• @gitfool made their first contribution in #330

Full Changelog: v3.3.3...v3.3.4

What's Changed

🐛 Fixed bugs

• Shield from invalid git version by @kzu in #313

Full Changelog: v3.3.2...v3.3.3

What's Changed

🐛 Fixed bugs

• Bump ThisAssembly to get fix for C#11 raw strings by @kzu in #312

Full Changelog: v3.3.1...v3.3.2

What's Changed

🔨 Other

• Bump to downstream ThisAssembly without SponsorLink by @kzu in #305

Full Changelog: v3.3.0...v3.3.1

What's Changed

🔨 Other

• Remove current implementation of SponsorLink for now by @kzu in #302

Full Changelog: v3.2.0...v3.3.0

Full Changelog

Full Changelog

:twisted_rightwards_arrows: Merged:

• replace all invalid chars in semver string with "-" #295 (@smorokin)

Full Changelog

:bug: Fixed bugs:

• IsDirty is no more constant #287
• IsDirty always false #285

Full Changelog

:bug: Fixed bugs:

• Ensure IsDirty is a constant #288 (@kzu)

Full Changelog

:sparkles: Implemented enhancements:

• Branch name is wrong when compiling from a git worktree #189

:bug: Fixed bugs:

• Version 3.0.5: Error 'ThisAssembly.Git' is inaccessible due to its protection level #273

Full Changelog

:sparkles: Implemented enhancements:

• Allow forcing templated code gen for C# #269 (@kzu)

:bug: Fixed bugs:

• The name 'IsDirtyString' does not exist in the current context #281
• Update to version 3.x breaks Avalonia projects #260
• CSC : error SL01: SponsorLink has been incorrectly configured #251
• Fix missing code from missing dependency #282 (@kzu)

:twisted_rightwards_arrows: Merged:

• Additional bump to get complete fix #283 (@kzu)

Full Changelog

:bug: Fixed bugs:

• ThisAssemblyNamespace is ignored when updating from 2.3.0 to 3.0.4 #258
• Bump to ThisAssembly version that doesn't run so early #268 (@kzu)
• Fix IsDirty generator when using a custom namespace #267 (@kzu)
• Fix backs-compat generation when custom namespace in use #266 (@kzu)

:twisted_rightwards_arrows: Merged:

• fix typo 'alwas' with 'always' #257 (@codingdave)
• Set AzureDevOps branch name also for PR #256 (@trejjam)

Full Changelog

:bug: Fixed bugs:

• Branch Names with '/' generate invalid versions #244
• V3 IsDirty is a string #243
• Migration from v2 -> v3 #240
• Reintroduce IsDirty boolean property from 2.3 #249 (@kzu)
• Replace / and \ in branches with dashes when setting default Version #248 (@kzu)

Full Changelog

:sparkles: Implemented enhancements:

• 💜 Bump SponsorLink for better privacy #242 (@kzu)

Full Changelog

:sparkles: Implemented enhancements:

• Make sure we don't surface SponsorLink as an API #241 (@kzu)

Full Changelog

:twisted_rightwards_arrows: Merged:

• Rename Analyzer > GitInfo.CodeAnalysis #233 (@kzu)

Full Changelog

:sparkles: Implemented enhancements:

• Set Version and PackageVersion to a default value #232 (@kzu)

Full Changelog

:sparkles: Implemented enhancements:

• Stale info on unrelated changes #186
• Should $(GitDefaultBranch) now default to main rather than master #167
• Integrate better with SourceLink and built-in support in the SDK #128
• Switch to ThisAssembly.Constants for C# #229 (@kzu)
• Properly detect HEAD changes for incremental builds #226 (@kzu)
• Change GitDefaultBranch to main instead of master #225 (@kzu)
• Improve targets organization by moving ThisAssembly to another targets #219 (@kzu)
• Switch to built-in .NET SDK AssemblyMetadata support #218 (@kzu)

:bug: Fixed bugs:

• Missing Git Information with Docker build #216
• Version issue with Multi-target projects #202
• Git isDirty triggers rebuilds #183
• GitInfo.cache collects warnings which leads to build errors #91

:hammer: Other:

• $(GitBranch) prop value is empty in .csproj file #178

:twisted_rightwards_arrows: Merged:

• Delete removed define for assembly metadata #220 (@kzu)

Full Changelog

:bug: Fixed bugs:

• make the gitinfo caches location configurable to be able to reuse the same information over several projects that are built #190

:twisted_rightwards_arrows: Merged:

• Feature/use git info cache for all solution projects #191 (@tisis2)

Full Changelog

:sparkles: Implemented enhancements:

• maybe: show better error msg if windows visual studio git outputs linux paths #131
• Add release notes #89
• Can the same be used for managed C++? If not create it? #67
• Cake: Use within Cake #48
• Doesn't work with projects on SMB shares #8
• Add section on how to set versions from MSBuild #211 (@kzu)
• Fix "MSBuild customizations" misnomer & add link to documentation #206 (@JimmyCushnie)
• fix bug Branch name is wrong when compiling from a git worktree #197 (@li-zhixin)
• Properly escape GitExe and CygPathExe for WSL #195 (@socram8888)
• Update "dirty" file only when GitIsDirty changes #184 (@AmoreCadenza)
• Fix of buildTransitive feature of package #182 (@PadreSVK)

:bug: Fixed bugs:

• MSBuild variables don't work for MAUI projects #203
• Execution fails if using WSL and username contains spaces #194
• delete #193
• [Question] Commit Message #185
• Build fails if git config log.showSignature true #180
• Disable signatures when obtaining commit date - fixes #180 #213 (@socram8888)

:hammer: Other:

• Deleted #181
• Publish new version to nuget.org #159

:twisted_rightwards_arrows: Merged:

• +Mᐁ includes #207 (@devlooped-bot)
• +M▼ includes #200 (@github-actions[bot])
• Integrate .csproj section on code example on README.md #173 (@paonath)

Full Changelog

:sparkles: Implemented enhancements:

• Add source repository information to package #169
• Add support for nuget transitive dependencies (via PackageReference) #154
• GitThisAssemblyMetadata documentation is confusing #152
• Feature request: let _CommitDateFormat be configurable #144
• Build error when the first commit on a new branch is a cherry pick #133
• support for git worktree #88
• Issue with GitIsDirty and GitCache #60

:bug: Fixed bugs:

• Handle add non-zero exit codes from Git #147 (@Therzok)

:hammer: Other:

• Project URL should be devlooped.github.io/GitInfo #149

:twisted_rightwards_arrows: Merged:

• 🖆 Apply devlooped/oss template, nugetize and modernize #168 (@kzu)
• Is dirty always check #165 (@freza-tm)
• Add support for nuget transitive dependecy for .targets #155 (@PadreSVK)
• Updating content readme.txt for issue #152 #153 (@daiplusplus)
• Allowed git commit date format to be configured through GitCommitDateFormat property #145 (@tomcurran)
• Add --always to default name-rev args, so a commit hash is used instead of 'undefined' #132 (@andersforsgren)

Full Changelog

:sparkles: Implemented enhancements:

• Option to exclude merges when calculating SemVerPatch #124
• RepositoryUrl may contain username and password #122
• Folder Syntax are not supported #101
• Only consider version tags #100
• Add "CheckinDate" to the ThisAssembly to be used in AssemblyInfo #65
• Error when the path to file GitInfo.txt contains spaces #13
• Include boolean indicating whether working tree is dirty #10
• GitExe in the PATH should be first #6
• Thoughts on including date information #2

:hammer: Other:

• Possibility to exclude tag refs from $(GitBranch) #126
• "Unrecognized escape sequence" when remote url is a Windows path #119
• GitSemVerPatch always 0 after update from 2.0.26 to 2.0.29 #116
• Add GitSha override when building #114
• Use MSBuild property to determine base version instead of external file #113
• [Feature] Retrieve repository url #109
• ASP.NET Core 3.1 GitThisAssemblyMetadata setting? #108
• Change ThisAssembly access to Public #107
• Include origin in git info #103
• Can't Get BaseVersion.Patch+1 #99
• Build fails if git config log.showSignature true #86
• Emit assembly attributes #85
• Conflicts when using InternalsVisibleTo #84
• Broken link #83
• Incremental build is broken #81
• dotnet tool #79
• Question regarding ThisAssembly.Git.Tag - separate commit using a plus? #78
• Is there a way to make GitInfo work with Xamarin Live Player #77
• GitInfo.txt per project leaves GitSemVerPatch at zero #76
• How to add pre-release information only if building from dev branches or on dev box #70
• Default protection level of ThisAssembly #69
• Info on target (release/debug/...)? #68
• csproj example #62
• Cannot use on OSX #61
• Preffered Version Scheme #59
• naming clash? "ThisAssembly" exists in Microsoft.Build.Utilities.v4.0 #56
• Cannot access internal class "ThisAssembly" here #55
• Commits not counting correctly when base branch is already ahead #54
• Examples to increase the counters. #49
• Clean up the output by using EchoOff for Exec #47
• If no Git found, build should fail #46
• HOWTO dotnet core nuget versioning #45
• Using GitInfo in a WPF app causes build failure #44
• Assembly Metadata IsDirty must be a string #43
• Build fails from dotnet publish #41
• Templates should have the <auto-generated /> tag as first line #39
• packed-refs need be tracked. #37
• ThisAssembly.Git.Commit: Information Mis-match #33
• VB.Net: Strict Mode #32
• Using GitSemVer in TFS builds/releases. #29
• Branch names with slashes are chopped #27
• Set default value for GitIsDirty #23
• Confused about where values come from #21
• override ThisAssemblyNamespace #20
• Build error with 1.1.32 #17
• Usefulness of Git.SemVer.Patch compared to Git.Commits? #9
• Cant get it to work on Universal Windows Platform #7
• Tag prefix per project possible ? #5
• Still -Pre release on nuget? #1

:twisted_rightwards_arrows: Merged:

• Allow tag and base version customization, flex matching #129 (@kzu)
• Prevent tag refs in $(GitBranch) for detached heads. #127 (@andersforsgren)
• Add GitCommitsIgnoreMerges option #125 (@christianerbsmehl)
• Remove username and password from repository URL #123 (@sbj42)
• Add GitCommitDate (#65) #121 (@nikolamilekic)
• Use verbatim string literals in C# and F# templates #120 (@sbj42)
• Fix GitSemVerPatch always 0 #117 (@ysc3839)
• Make the PATCH / GitBaseVersionPatch optional #115 (@BoBiene)
• Fix GitThisAssemblyMetadata #112 (@joacar)
• Add repository url #111 (@joacar)
• fixed #98 #110 (@pedoc)
• Turn off signature display when running log #102 (@kzu)
• Fix SemVer.Source not working in Visual Basic #97 (@MobileManiC)
• F# support #93 (@ndani14)
• Don't cause MSBuild warnings 'expected' failures #90 (@alanmcgovern)
• Fix incremental build #82 (@shadow-cs)
• Reintroduce NormalizeDirectory usage, fix actual error #75 (@kzu)
• Ensure we normalize to the correct path separator #73 (@alanmcgovern)
• Allow counting all commits in the repository #66 (@alanmcgovern)
• Ensuring the GitExe is set when the initial target is not evaluated #58 (@adalon)
• Fix for cygwin/WSL and add support for Windows Store WSL distros #57 (@chkn)
• Add support for multi-targeting builds to retrieve Git information #53 (@kzu)
• v2 #52 (@kzu)
• Switch to 2017 image #51 (@kzu)
• Use MSBuildRuntimeTime to discern xbuild #50 (@abock)
• Don't do xbuild things on Windows #42 (@bojanrajkovic)
• Add <auto-generated /> comments to templates #40 (@bvli)
• track packed-refs as refs/heads may be empty when "packed-refs -all" have been used #38 (@bigbearzhu)
• VB.Net: Strict Mode, fixes #32 #36 (@wahmedswl)
• fixes #32 #35 (@wahmedswl)
• Add support for git in WSL #31 (@chkn)
• Update documentation (and whitespace) #26 (@dueringa)
• Set default value for GitIsDirty in non-repos #25 (@dueringa)
• Set default value for GitIsDirty in non-repos #24 (@dueringa)
• Added support for worktrees #22 (@taylorjonl)
• Update GitInputs list to include branch heads recursively #19 (@bigbearzhu)
• add missing close paren breaking markdown link #11 (@jamesmanning)
• Fix cygwin support #4 (@chkn)
• Untabification of readme.txt #3 (@atifaziz)

* This Changelog was automatically generated by github_changelog_generator