Set Version and PackageVersion to a default value #232
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
It's not entirely intuitive that you install GitInfo and by default
"nothing happens", as in, you get new code from ThisAssembly,
but otherwise, no versioning changes happen. This might be
counterintuitive to newcomers, who might just care to get
something (a sensible default) going, before investing more
in customizing GitInfo.
This is how MinVer does it (provided there's a version tag
in the repository) and it's quite intuitive.
The way we do it here should be mostly backwards compat
because:
1. Users leveraging assembly-version attributes will already
have disabled .NET SDK assembly attribute generation
2. Users leveraging MSBuild targets to do this would be
following the recommended guidance of creating a target
that runs before specific targets, not as InitialTargets
We make our version-setting target run as an inital target,
which may have a minor impact on initial build perf, but
but shouldn't be a problem since the same targets are
run for DTB anyway (if you make them run before
GetAssemblyVersion, which also runs before
BeforeCompile and CoreCompile in the SDK).
By being an initial target, we allow for existing customization
in pretty much any target, prevail our own one, which becomes
just a default.
Even so, we check for GitVersion=false as an escape hatch for
users who may encounter unforseen broken scenarios.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
It's not entirely intuitive that you install GitInfo and by default "nothing happens", as in, you get new code from ThisAssembly, but otherwise, no versioning changes happen. This might be counterintuitive to newcomers, who might just care to get something (a sensible default) going, before investing more in customizing GitInfo.
This is how MinVer does it (provided there's a version tag in the repository) and it's quite intuitive.
The way we do it here should be mostly backwards compat because:
We make our version-setting target run as an inital target, which may have a minor impact on initial build perf, but but shouldn't be a problem since the same targets are run for DTB anyway (if you make them run before
GetAssemblyVersion, which also runs before
BeforeCompile and CoreCompile in the SDK).
By being an initial target, we allow for existing customization in pretty much any target, prevail our own one, which becomes just a default.
Even so, we check for GitVersion=false as an escape hatch for users who may encounter unforseen broken scenarios.