-
Notifications
You must be signed in to change notification settings - Fork 4.8k
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.
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
Require package readmes for shipping packages #105019
Conversation
Tagging subscribers to this area: @dotnet/area-meta |
ef020a5
to
13e037a
Compare
Add a target that validates that a package readme exists for a shipping package. Set EnableDefaultPackageReadmeFile=false in projects that don't yet have a package readme.
13e037a
to
c42345d
Compare
I noticed that the
|
@am11 I changed a property so that this validation is only enabled for src/libraries packages (for now). |
Sounds good. I think the validation is probably hitting false-positive, because those are internal packages and nuget.org shows this line: runtime/Directory.Build.targets Line 77 in 66ae90f
|
Yes, we can revisit this when we want to expand the validation to other packages produced in runtime, outside of src/libraries. |
@dotnet/runtime-infrastructure, @ericstj would you mind reviewing? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good. I have questions.
Co-authored-by: Carlos Sánchez López <1175054+carlossanlop@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. Consider my comment suggestions optional. Feel free to wait for a review from Eric too.
Contributes to #99358
Add a target that validates that a package readme
exists for a shipping package.
Set EnableDefaultPackageReadmeFile=false in projects
that don't yet have a package readme.
I will send out a mail to the runtimerepo DL after this change is merged to explain that package readmes are now required and
to create energy on adding the remaining 30 package READMEs, ideally ready for .NET 9.