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.

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

Add readme to nuget packages #121

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Add readme to nuget packages #121

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7d52f02
add existing readme files to the NuGet packages
FroggieFrog Mar 18, 2024
438af4c
align properties to other projects
FroggieFrog Mar 18, 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
3 changes: 2 additions & 1 deletion src/BaGetter.Aliyun/BaGetter.Aliyun.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<TargetFramework>net8.0</TargetFramework>

<PackageTags>NuGet;Alibaba;Cloud</PackageTags>
<Description>The libraries to host BaGetter on Alibaba Cloud (Aliyun).</Description>
<TargetFramework>net8.0</TargetFramework>
</PropertyGroup>

<ItemGroup>
Expand Down
1 change: 1 addition & 0 deletions src/BaGetter.Core/BaGetter.Core.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

<PackageTags>NuGet</PackageTags>
<Description>The core libraries that power BaGetter.</Description>
<PackageReadmeFile>readme.md</PackageReadmeFile>
Copy link

Choose a reason for hiding this comment

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

I don't think this is always the right way. BaGetter.Core has a readme describing the source folder contents, which does not fit as package description on the gallery page. I'm not sure how to handle this though, since the readme here does fit a github page, describing its contents. Maybe an additional PackageReadme.md file for information to display on the gallery page?

</PropertyGroup>

<ItemGroup>
Expand Down
3 changes: 2 additions & 1 deletion src/BaGetter.Database.MySql/BaGetter.Database.MySql.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,10 @@

<PropertyGroup>
<TargetFramework>net8.0</TargetFramework>
<LangVersion>latest</LangVersion>

<PackageTags>NuGet</PackageTags>
<Description>The libraries to host BaGetter on MySQL.</Description>
<PackageReadmeFile>readme.md</PackageReadmeFile>
Copy link

Choose a reason for hiding this comment

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

The db provider projects have no fitting readme files either. They just describe how to add a migration for each db provider.

</PropertyGroup>

<ItemGroup>
Expand Down
1 change: 1 addition & 0 deletions src/BaGetter.Database.PostgreSql/BaGetter.Database.PostgreSql.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@

<PackageTags>NuGet</PackageTags>
<Description>The libraries to host BaGetter on PostgreSQL.</Description>
<PackageReadmeFile>readme.md</PackageReadmeFile>
</PropertyGroup>

<ItemGroup>
Expand Down
1 change: 1 addition & 0 deletions src/BaGetter.Database.SqlServer/BaGetter.Database.SqlServer.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@

<PackageTags>NuGet</PackageTags>
<Description>The libraries to host BaGetter on SQL Server.</Description>
<PackageReadmeFile>readme.md</PackageReadmeFile>
</PropertyGroup>

<ItemGroup>
Expand Down
2 changes: 2 additions & 0 deletions src/BaGetter.Database.Sqlite/BaGetter.Database.Sqlite.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,10 @@
<PropertyGroup>
<TargetFramework>net8.0</TargetFramework>
<Nullable>enable</Nullable>

<PackageTags>NuGet</PackageTags>
<Description>The libraries to host BaGetter on SQLite.</Description>
<PackageReadmeFile>readme.md</PackageReadmeFile>
</PropertyGroup>

<ItemGroup>
Expand Down
1 change: 1 addition & 0 deletions src/BaGetter.Protocol/BaGetter.Protocol.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@

<PackageTags>NuGet;Protocol</PackageTags>
<Description>Libraries to interact with NuGet server APIs.</Description>
<PackageReadmeFile>readme.md</PackageReadmeFile>
</PropertyGroup>

<ItemGroup>
Expand Down
2 changes: 2 additions & 0 deletions src/BaGetter/BaGetter.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

<PropertyGroup>
<TargetFramework>net8.0</TargetFramework>

<PackageReadmeFile>readme.md</PackageReadmeFile>
</PropertyGroup>

<ItemGroup>
Expand Down
4 changes: 4 additions & 0 deletions src/Directory.Build.props
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,8 @@
<None Include="../packageIcon.png" Pack="true" PackagePath="" Visible="false" />
</ItemGroup>

<ItemGroup Condition=" '$(PackageReadmeFile)' != '' ">
<None Include="$(DefiningProjectDirectory)$(PackageReadmeFile)" Pack="True" PackagePath="" />
</ItemGroup>

</Project>