Skip to content
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

Improve NuGet package metadata #96

Merged
merged 9 commits into from
Oct 19, 2024

Conversation

swharden
Copy link
Contributor

This PR improves the OwaspHeaders.Core NuGet package by adding the following features:

  • Use the MIT license expression
  • Include debug symbols
  • Add package and repository URLs
  • Add support for Source Link
  • Enable deterministic builds
  • Add a package icon

NuGet Page

note: The "after" is a screenshot of a different repository that includes the features this PR adds, hence the different file size

before after
image image

NuGet Package Explorer

before after
image image

@swharden
Copy link
Contributor Author

Icon Notes

If you're not a fan of the icon/logo we can come up with something different. The following describes how I created this design:

I started with images generated using ChatGPT with the following prompts

Generate an icon for the "OwaspHeaders.Core" NuGet package. It is an ASP .NET Core middleware for injection OWASP recommended HTTP Headers for increased security. Keep the icon design minimalistic, use vector style, and limit the number of different colors

Make one with a white background and make it much less complex

I liked the idea of the shield with a browser inside of it. I replaced the (H) with a wasp. The OWASP logo is protected to I just made one from scratch.

Icon Notes

image

image

I started with two random wasp images I found on Google Image Search, then drew my own combining parts I liked from each using InkScape. The final design came out great, and I made the stinger super pointy so it would show up when scaled small.

image
image

I then added the shield design with a browser window inside from ChatGPT's suggestions, and this is the final design. This PR includes a SVG file so it can be edited if/as desired.

@GaProgMan
Copy link
Owner

GaProgMan commented Oct 19, 2024

Thank you so much for this @swharden. It's an example of a perfect pull request (in my eyes).

I'm going to make one or two tiny changes ahead of merging though. Both are very small:

  • I need to update the patch version number (otherwise the push to NuGet will fail)
  • I need to set the PackageProjectUrl (I'll likely just use the GitHub repo for now*)

* future me needs to go ahead and create a github io page for the package and build up some more detailed documentation for it. But that's a future me problem at this point.

@GaProgMan GaProgMan self-requested a review October 19, 2024 21:53
@swharden

This comment was marked as outdated.

Co-authored-by: Jamie Taylor <[email protected]>
@GaProgMan
Copy link
Owner

Thank you for these updates @swharden.

If you haven't seen the recent news about .io domains... 😅😅😅
https://every.to/p/the-disappearance-of-an-internet-domain

Hopefully that gets figured out soon!

I did, and I hope it's sorted out soon too.

@GaProgMan GaProgMan merged commit 01c2247 into GaProgMan:main Oct 19, 2024
2 checks passed
@swharden swharden deleted the improve-nuget-package branch October 19, 2024 22:08
@swharden
Copy link
Contributor Author

swharden commented Oct 19, 2024

Looks like it all worked! 🚀

  • Use the MIT license expression
  • Include debug symbols
  • Add package and repository URLs
  • Add support for Source Link
  • Enable deterministic builds
  • Add a package icon

image

image

image

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants