Skip to content

Add NuGet package READMEs #2808

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
domaindrivendev merged 2 commits into from
Apr 24, 2024
Merged

Add NuGet package READMEs #2808

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1382ddb
Add NuGet package README
martincostello Apr 16, 2024
9df5aa3
Update links to HTTPS
martincostello Apr 16, 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
Next Next commit
Add NuGet package README 
Add a simple common README file for all NuGet packages.
  • Loading branch information
@martincostello
martincostello committed Apr 16, 2024
commit 1382ddb92fe0793008bfee3dd39c4f72bb22c52a
3 changes: 0 additions & 3 deletions Directory.Build.props
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,7 @@
<PackageIcon></PackageIcon>
<PackageLicenseExpression>MIT</PackageLicenseExpression>
<PackageProjectUrl>https://github.com/domaindrivendev/Swashbuckle.AspNetCore</PackageProjectUrl>
<!--
TODO Create a generic package README file for the project
<PackageReadmeFile>package-readme.md</PackageReadmeFile>
-->
<PackageReleaseNotes>See $(PackageProjectUrl)/releases for details.</PackageReleaseNotes>
<PackageRequireLicenseAcceptance>false</PackageRequireLicenseAcceptance>
<PublishRepositoryUrl>true</PublishRepositoryUrl>
Expand Down
16 changes: 16 additions & 0 deletions package-readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Swashbuckle.AspNetCore

[Swagger](https://swagger.io) tooling for APIs built with ASP.NET Core.

Generate beautiful API documentation, including a UI to explore and test operations, directly from your routes, controllers and models.

[![Build status](https://github.com/domaindrivendev/Swashbuckle.AspNetCore/actions/workflows/build.yml/badge.svg?branch=master&event=push)](https://github.com/domaindrivendev/Swashbuckle.AspNetCore/actions?query=workflow%3Abuild+branch%3Amaster+event%3Apush) [![Code coverage](https://codecov.io/gh/domaindrivendev/Swashbuckle.AspNetCore/branch/master/graph/badge.svg)](https://codecov.io/gh/domaindrivendev/Swashbuckle.AspNetCore)
Copy link
Contributor

@dnperfors dnperfors Apr 23, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is the added value to add Build status and Code coverage badges to the package readme of the master branch?
When I look for a package and see the readme, I don't need to know if the master branch failed to build. It could be interesting to know what the code coverage is for the specific package version, but it wouldn't influence my decision to use a package very much (except perhaps if the coverage is 0%...)

Copy link
Collaborator Author

@martincostello martincostello Apr 23, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just because it's already in the README and it still renders correctly in NuGet's Content Security Policy. I've essentially kept the "top" of the repo README, but with everything their CSP policy forbids, such as the OpenSSF Scorecard badge.

Copy link
Collaborator Author

@martincostello martincostello Apr 23, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The coverage also wouldn't be "a" version. It would just be "now". Aligning that as burned-in content in the package is too much engineering effort.

Copy link
Contributor

@dnperfors dnperfors Apr 23, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The coverage also wouldn't be "a" version. It would just be "now". Aligning that as burned-in content in the package is too much engineering effort.

Possibly it might be done using the /tags/{versionnumber} url, but indeed the effort doesn't really warrant that change.

Anyways, I just wanted to raise the question of the necessity for these badges in the package readme.


## Release notes

- The repository's [releases](https://github.com/domaindrivendev/Swashbuckle.AspNetCore/releases) describes changes by release.
- We tag Pull Requests and Issues with [milestones](https://github.com/domaindrivendev/Swashbuckle.AspNetCore/milestones) which match to NuGet package release numbers.

## Documentation and Samples

Documentation, and samples, for using Swashbuckle.AspNetCore can be found in the repository's [README](https://github.com/domaindrivendev/Swashbuckle.AspNetCore#readme).