Skip to content

Include Readme.md in packages #57809

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Sep 12, 2024
Merged

Include Readme.md in packages #57809

Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
fb9f24a
Include Readme.md in packages
wtgodbe Sep 11, 2024
e134410
Fix
wtgodbe Sep 11, 2024
5cfa382
Try this
wtgodbe Sep 11, 2024
82af04d
Fix syntax
wtgodbe Sep 11, 2024
debcfe2
Remove bad ref
wtgodbe Sep 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions Directory.Build.props
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -239,6 +239,20 @@
<ArchiveExtension Condition="'$(TargetOsName)' == 'win'">.zip</ArchiveExtension>
</PropertyGroup>

<PropertyGroup>
<!-- PackageReadmeFile specifies the package readme file name in the package. PackageReadmeFilePath points to the package readme file on disk. -->
<EnableDefaultPackageReadmeFile Condition="'$(EnableDefaultPackageReadmeFile)' == '' and '$(IsShipping)' != 'false'">true</EnableDefaultPackageReadmeFile>
<PackageReadmeFilePath Condition="'$(PackageReadmeFilePath)' == '' and '$(EnableDefaultPackageReadmeFile)' == 'true'">PACKAGE.md</PackageReadmeFilePath>
<PackageReadmeFile Condition="'$(PackageReadmeFile)' == '' and '$(EnableDefaultPackageReadmeFile)' == 'true' and Exists('$(PackageReadmeFilePath)' )">PACKAGE.md</PackageReadmeFile>
<!-- Uncomment this once all packages have ReadMes -->
<!-- <BeforePack>$(BeforePack);ValidatePackageReadmeExists</BeforePack> -->
</PropertyGroup>

<!-- Add a package README file -->
<ItemGroup Condition="'$(PackageReadmeFilePath)' != '' and Exists('$(PackageReadmeFilePath)' )">
<None Include="$(PackageReadmeFilePath)" Pack="true" PackagePath="\" />
</ItemGroup>

<PropertyGroup>
<!-- Set the arcade before common targets so we compute ExcludeFromBuild before arcade uses it. -->
<CustomBeforeMicrosoftCommonTargets>$(MSBuildThisFileDirectory)Directory.Build.BeforeCommonTargets.targets</CustomBeforeMicrosoftCommonTargets>
Expand Down