Skip to content

Readme support for packages#3634

Merged
zkat merged 2 commits intodevfrom
dev-feature-readme
Mar 15, 2021
Merged

Readme support for packages#3634
zkat merged 2 commits intodevfrom
dev-feature-readme

Conversation

@zkat
Copy link
Copy Markdown
Contributor

@zkat zkat commented Sep 2, 2020

This PR merges in the main changes for the Readme feature into dev

@zkat zkat force-pushed the dev-feature-readme branch from e9a08fd to 0cf923d Compare September 3, 2020 00:08
@zkat zkat marked this pull request as ready for review September 3, 2020 00:08
@zkat zkat requested a review from a team as a code owner September 3, 2020 00:08
@donnie-msft
Copy link
Copy Markdown
Contributor

@zkat what's the status of this one?

@nkolev92
Copy link
Copy Markdown
Member

🔔

Can you please update the status here?

Given that it is a feature branch merge, I imagine just rebasing and re-runing the tests is required.

@zkat zkat force-pushed the dev-feature-readme branch from 0cf923d to 47b99b9 Compare March 2, 2021 00:08
@zkat
Copy link
Copy Markdown
Contributor Author

zkat commented Mar 2, 2021

just rebased it. Fingers crossed that I fixed the conflicts correctly :)

Copy link
Copy Markdown

@chrisraygill chrisraygill left a comment

Choose a reason for hiding this comment

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

LGTM with general suggestion to change README --> Readme

Comment thread src/NuGet.Clients/NuGet.PackageManagement.UI/Resources.resx Outdated
Comment thread src/NuGet.Clients/NuGet.PackageManagement.UI/Resources.resx Outdated
Copy link
Copy Markdown
Member

@nkolev92 nkolev92 left a comment

Choose a reason for hiding this comment

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

We've largely reviewed this already.
cc @zivkan who was unsure about the protocol changes for the readme.

@zkat zkat force-pushed the dev-feature-readme branch 2 times, most recently from d1373ed to 8f2e8e5 Compare March 12, 2021 02:58
advay26-zz and others added 2 commits March 15, 2021 09:51
* Made basic changes to classes to allow for a Readme element in the nuspec file

* More changes for readme functionality

* Adding the readme property if 'readme.md' is present in the base directory

* Added support for dotnet pack for .csproj files

* Added validation for Readmes when packing, brought dotnet pack up to speed with nuget pack

* Changed variable names, changed error message for empty Readme

* Removed commented code

* Added a summary for the CheckForReadme method

* Added support for dotnet pack for .csproj files

* Added support for dotnet pack for .csproj files

* Added validation for Readmes when packing, brought dotnet pack up to speed with nuget pack

* Changed variable names, changed error message for empty Readme

* Updated PublicAPI.Unshipped.txt files

* Changed some spacing

* Wrote tests for packing embedded readmes

* Removed automatic packing of readmes from base directory

* Used platform independent directory separating chars for testing

* Update src/NuGet.Core/NuGet.Packaging/PackageCreation/Authoring/ManifestMetadata.cs

Co-authored-by: donnie-msft <[email protected]>

* Updated PublicAPI files after file structure was modified

* Reverted to 'Readme == string.Empty' so that the Readme element remains optional

* Removed 1 MB file size check on pack

* Updated Public API files

* Updated Public API files again, builds fine locally

* Fixed a bug with dir. separating chars (which seemed to affect /* searches exclusively?), added some tests to catch it out

* Changed var name in one of the tests

* Changed tests that were constructed incorrectly for non-Windows platforms

* Added dotnet pack tests

Co-authored-by: donnie-msft <[email protected]>
* Made initial changes for PM UI work for Readmes

* Added ReadmeUrl element to all the relevant places, still using ProjectUrl to see an an actual link for now

* URL now shows when user hovers over the link's text

* Removed the placeholder URL value that used the ProjectUrl
@zkat zkat force-pushed the dev-feature-readme branch from 8f2e8e5 to 1919a94 Compare March 15, 2021 16:53
@zkat zkat merged commit dc2fada into dev Mar 15, 2021
@derigel23
Copy link
Copy Markdown

Is readme property mandatory now?

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.

6 participants