Implemented the Dirty flag

[pysco68]

Have been replacing a bunch of usages of the deprected Fody.Stamp with GitVersion lately and found that we need the "Dirty" flag as some others (see #1198). Just got ahead and implemented it.

Hope it'll meet the required project standards ;)

Description

Added a variable RepositoryDirtyFlag which is either null or Dirty to be able to add that suffix to my version strings.

Related Issue

As mentioned above: fixes #1198

Motivation and Context

How Has This Been Tested?

I added four test cases which test the behavior of the dirty flag in /src/GitVersionCore.Tests/IntegrationTests/OtherScenarios.cs.

It should be set when there's any non-ignored change vs the HEAD of the repo (that includes staged files).

Other than that I had to change a some other test cases which work on the outputed data to make them work again

Screenshots (if appropriate):

Checklist:

• My code follows the code style of this project. (hope so :))
• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I have added tests to cover my changes.
• All new and existing tests passed. (I had a bug in a subset of the tests for the netcoreapp2.1 build which seemed to be related to some specifics on my env)

[arturcic]

@asbjornu can you review this one as well?

[pysco68]

@asbjornu looks like the test image for the failed one couldn't fetch the repo from github.com for some reason. Name-resolution perhaps?

[arturcic]

@asbjornu looks like the test image for the failed one couldn't fetch the repo from github.com for some reason. Name-resolution perhaps?

fixed

[asbjornu]

Excellent, thank you so much for your contributions @pysco68! 🙏

[pysco68]

Happy I could help :)

[arturcic]

🎉 This issue has been resolved in version 5.5.0 🎉
The release is available on:

• GitHub Release
• Chocolatey Package
• .Net Global Tool

Your GitReleaseManager bot 📦🚀

[LazaroOnline]

Hello, I can't find how to use the dirty flag.
I don't find it at:
https://gitversion.net/docs/
I'm trying in the GitVersion.yml file to add something like:

assembly-informational-format: 'git-{ShortSha}-{BranchName}--{CommitDate}-{RepositoryDirtyFlag}'

but no luck. Any help/doc/reference?

[asbjornu]

@LazaroOnline, the description in the PR does not reflect what was implemented. The property changed name to UncommittedChanges and its type is an integer indicating the number of uncommitted changes. A PR that updates the docs would be highly appreciated. 🙏

[LazaroOnline]

Under the new name UncommittedChanges it is already in the API docs:
https://gitversion.net/api/GitVersion/SemanticVersionBuildMetaData/
https://gitversion.net/api/GitVersion/SemanticVersionBuildMetaData/4EEF3F34
https://gitversion.net/docs/more-info/variables

The only missing part I think would be at:
https://gitversion.net/docs/configuration
with a small description.

It is nice to have this new variable, however in my case I miss some additional features related to it,
like uncommitted file filters to exclude files from being counted inUncommittedChanges,
because some files may get changed during build or that doesn't affect the resulting DLL, for example:
".txt",
".md",
".config",
".json",
".js",
".css",
...

[asbjornu]

The only missing part I think would be at: https://gitversion.net/docs/configuration with a small description.

Yes, that would be a nice addition.

It is nice to have this new variable, however in my case I miss some additional features related to it, like uncommitted file filters to exclude files from being counted inUncommittedChanges, because some files may get changed during build or that doesn't affect the resulting DLL,

It sounds like if .gitignore was taken into account, that should solve your use-case. And I can agree that would be useful. But we are basing the implementation on what LibGit2Sharp exposes and it's out of scope to do anything about .gitignore in GitVersion. If you figure out a way to do this with LibGit2Sharp, a PR is welcome.