Revert to Changelog link in Nuget rather than Release Notes #11675
Conversation
chidozieononiwu
requested review from
danieljurek,
mitchdenny and
weshaggard
as code owners
eng/Directory.Build.Data.targets
Outdated
| <Output TaskParameter="ConsoleOutput" ItemName="ExtractedReleaseNotesTemp" /> | ||
| <Output TaskParameter="ExitCode" PropertyName="SetReleaseNotesErrorCode" /> | ||
| </Exec> | ||
| <Error Condition="Exists('$(ChangeLogPath)') and '$(SetReleaseNotesErrorCode)' != '0'" Text="No entry for version [$(_VersionInProject)] found in the ChangeLog [$(ChangeLogPath)]. @(ExtractedReleaseNotesTemp)" /> |
There was a problem hiding this comment.
While we aren't extracting the notes anymore it seems like we should still validate that there is an entry for the version still. Perhaps we can turn this into a validate release notes exists target?
eng/Directory.Build.Data.targets
Outdated
| <PackageProjectUrl Condition="Exists('$(PackageRootPath)/README.md') and '$(SkipDevBuildNumber)' != 'true'">$([System.UriBuilder]::new($(RepositoryUrl)/blob/$(SourceRevisionId)/$(DirectoryPartofPath)README.md).Uri)</PackageProjectUrl> | ||
| <PackageProjectUrl Condition="Exists('$(PackageRootPath)/README.md') and '$(SkipDevBuildNumber)' != 'true'">$([System.UriBuilder]::new($(RepositoryUrl)/blob/$(MSBuildProjectName)_$(Version)/$(DirectoryPartofPath)README.md).Uri)</PackageProjectUrl> | ||
| <PackageReleaseNotes Condition="Exists('$(PackageRootPath)/CHANGELOG.md') and '$(SkipDevBuildNumber)' == 'true'">$([System.UriBuilder]::new($(RepositoryUrl)/blob/$(SourceRevisionId)/$(DirectoryPartofPath)CHANGELOG.md).Uri)</PackageReleaseNotes> | ||
| <PackageReleaseNotes Condition="Exists('$(PackageRootPath)/CHANGELOG.md') and '$(SkipDevBuildNumber)' == 'true'">$([System.UriBuilder]::new($(RepositoryUrl)/blob/$(MSBuildProjectName)_$(Version)/$(DirectoryPartofPath)CHANGELOG.md).Uri)</PackageReleaseNotes> |
There was a problem hiding this comment.
Should this be MSBuildProjectName or PackageName?
There was a problem hiding this comment.
Are they not the same thing for Packages in this Repo? I don't see PackageName set as a property anywhere in the build.
There was a problem hiding this comment.
I think they generally are, I thought cogservices wasn't but it turns out they are. It turns out nuget ends up using PackageId (https://github.com/NuGet/NuGet.Client/blob/dev/src/NuGet.Core/NuGet.Build.Tasks.Pack/NuGet.Build.Tasks.Pack.targets#L27) which defaults to AssemblyName which defaults to MSBuildProjectName. So I suggest using PackageId, assuming it is set before our target, just incase one of our projects end up with a custom name for some reason.
chidozieononiwu
force-pushed
the
RevertToChangeLogLink
branch
2 times, most recently
from
644ee23 to
abdc61b
Compare
chidozieononiwu
force-pushed
the
RevertToChangeLogLink
branch
from
abdc61b to
fc3f37f
Compare
Convert GetCurrentReleaseNotes to ValidateReleaseNotes
chidozieononiwu
force-pushed
the
RevertToChangeLogLink
branch
from
fc3f37f to
3bcc158
Compare
Reverting to using link to CHANGELOG.md in Nuget rather that extracted releaseNotes.