EnC: Add asterisk based assembly version docs #73364
Merged
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
dotnet-issue-labeler
bot
added
Area-Infrastructure
untriaged
|
@AArnott please review if Nerdbank.GitVersioning info is accurate. |
|
@davidwengier PTAL |
AArnott
reviewed
May 7, 2024
| It is thus highly recommended to use alternative versioning methods, such as [Nerdbank.GitVersioning](https://github.com/dotnet/Nerdbank.GitVersioning), that derive the assembly version | ||
| from the HEAD commit SHA (for git repositories). | ||
|
|
||
| > To enable generating commit SHA based assembly versions using `Nerdbank.GitVersioning` package, specify `{ "assemblyVersion" : {"precision": "revision"} }` setting in `version.json`. |
There was a problem hiding this comment.
This is accurate, although I wonder if it's common for users to use wildcards with AssemblyVersion as opposed to AssemblyFileVersion. Having AssemblyVersion change with every single has at least historically been problematic (for strong named assemblies) so I would expect wildcards to be used for the file version instead. And in that case, this JSON isn't necessary, because AssemblyFileVersion by default includes a commit SHA component.
There was a problem hiding this comment.
We have seen customers using wildcard in assembly version, which is causing Hot Reload issues.
davidwengier
approved these changes
May 7, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Document workaround for projects containing
*in assembly version.