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

#1733: add readme for use in nuget readme documentation #1773

Merged
merged 1 commit into from Apr 2, 2024

Conversation

schambers
Copy link
Member

Adds a readme doc that will strictly be used on the nuget project page located here https://www.nuget.org/packages/FluentMigrator

Fixes #1733

@schambers schambers added the documentation Annoying, but important label Mar 31, 2024
@schambers
Copy link
Member Author

For your review @jzabroski

@schambers schambers marked this pull request as ready for review March 31, 2024 22:32
@jzabroski
Copy link
Collaborator

Shouldn't the Readme xml tag say - nuget in the filename? Have not closely read how this works.

@schambers
Copy link
Member Author

@jzabroski you should need to specify where the readme file is located at. I don't believe it needs to be named anything special.

@jzabroski jzabroski added this to the 6.0.0 milestone Apr 2, 2024
@jzabroski jzabroski merged commit adf25d9 into main Apr 2, 2024
3 checks passed
@jzabroski jzabroski deleted the feature/issue-1733-nuget-readme branch April 2, 2024 10:16
@jzabroski
Copy link
Collaborator

I think we might need to upgrade nuget on the ci build to a newer version from 5.4?

Attempting to build package from 'FluentMigrator.Console.nuspec'.
The element 'files' in namespace 'http://schemas.microsoft.com/packaging/2010/07/nuspec.xsd' has invalid child element 'readme' in namespace 'http://schemas.microsoft.com/packaging/2010/07/nuspec.xsd'. List of possible elements expected: 'file' in namespace 'http://schemas.microsoft.com/packaging/2010/07/nuspec.xsd'. This validation error occurred in a 'readme' element.

@jzabroski
Copy link
Collaborator

It looks like it needs to say:

                <readme>docs\README-nuget.md</readme>
	</metadata>
	<files>
		<file src="_._" target="content"/>
		<file src="tools/" />
		<file src="docs/README-nuget.md" target="docs" />
	</files>
</package>

Not done investigating.

@jzabroski
Copy link
Collaborator

Resolved last night.

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

Successfully merging this pull request may close these issues.

fluentmigrator is missing NuGet package README file
2 participants