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

Projects cleanup #250

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Projects cleanup #250

wants to merge 3 commits into from

Conversation

0xced
Copy link
Contributor

@0xced 0xced commented May 28, 2024

This simplifies the project by moving as much as possible into the Directory.Build.props file.

Also, by using <GenerateDocumentationFile>true</GenerateDocumentationFile> instead of DocumentationFile, the xmldoc files are generated inside the obj directory, avoiding to pollute the different projects with the generated xmldoc files (which will still be included in the NuGet packages).

Finally, package validation as been enabled for all projects instead of only the main ZiggyCreatures.FusionCache project.

0xced added 3 commits May 28, 2024 15:10
* Move the logo png file in a single location
* Define the logo and README related packaging info in Directory.Build.props
So that it can be shared in the Directory.Build.props file and doesn't clutter the directories since it's generated inside the obj directory by default.
Also update the baseline versions to the latest released NuGet packages
Copy link
Collaborator

@jodydonetti jodydonetti left a comment

Choose a reason for hiding this comment

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

Hi, thanks for the PR and the time spent!

Currently though, I don't feel like going down this path, let me explain.

The logo being duplicated is no big deal honestly, at least related to the size on disk (5K each, < 50K total). Also, right now they are all the same, but I have an idea sitting around about modifying them per-package, one day or another.

For the readme maybe that can be the case, but I'm wondering about centralizing something like a path to a local file (meaning "local" per project) with the MSBuild expression and the IsSrcProject and... I don't know, is it really worth it? Or is it better to have that single line in the csproj file without having to look around and resolve the MSBuild expression etc?

Thoughts?

Copy link
Collaborator

@jodydonetti jodydonetti left a comment

Choose a reason for hiding this comment

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

Oh, also: the usage of <GenerateDocumentationFile>true</GenerateDocumentationFile> instead of DocumentationFile is nice instead, I didn't know about it, this I like a lot!

Thanks for making me learn something new 🙂

Finally, I agree to enable package validation for all projects, but I would put it into each csproj file, to have more granular control with each project's build process.

Thoughts?

@jodydonetti
Copy link
Collaborator

Hi @0xced , I was trying to update your fork to finish merging this, but got a "permission denied": would you like to grant me access so I can align everything and get to merge the changes?

Let me know, thanks!

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