Ensure all shipped NuGet packages have meaningful descriptions and tags - #1432
Conversation
|
🚀 Dogfood this PR with:
curl -fsSL https://raw.githubusercontent.com/CommunityToolkit/Aspire/main/eng/scripts/dogfood-pr.sh | bash -s -- 1432Or
iex "& { $(irm https://raw.githubusercontent.com/CommunityToolkit/Aspire/main/eng/scripts/dogfood-pr.ps1) } 1432" |
There was a problem hiding this comment.
Pull request overview
This PR standardizes NuGet package metadata across packable projects under src/ by ensuring each package has a meaningful <Description> and consistent/appropriate AdditionalPackageTags, aligning wording/casing with Aspire conventions.
Changes:
- Added missing
<Description>andAdditionalPackageTagsto packages that shipped without them. - Normalized existing descriptions for grammar, product-name casing, and punctuation consistency.
- Clarified descriptions to better reflect the underlying container/tool being integrated.
Reviewed changes
Copilot reviewed 16 out of 16 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| src/CommunityToolkit.Aspire.Logto.Client/CommunityToolkit.Aspire.Logto.Client.csproj | Adds package description and tags for the Logto client integration (formatting/indentation needs alignment). |
| src/CommunityToolkit.Aspire.Hosting.Azure.Dapr.Redis/CommunityToolkit.Aspire.Hosting.Azure.Dapr.Redis.csproj | Adds description and tags for the Azure Cache for Redis Dapr integration. |
| src/CommunityToolkit.Aspire.Hosting.Zitadel/CommunityToolkit.Aspire.Hosting.Zitadel.csproj | Updates description for the ZITADEL hosting integration (tags contain a typo). |
| src/CommunityToolkit.Aspire.Hosting.SqlServer.Extensions/CommunityToolkit.Aspire.Hosting.SqlServer.Extensions.csproj | Refines description casing/wording for SQL Server extensions package. |
| src/CommunityToolkit.Aspire.Hosting.RustFs/CommunityToolkit.Aspire.Hosting.RustFs.csproj | Refines description and punctuation for RustFS hosting integration. |
| src/CommunityToolkit.Aspire.Hosting.Redis.Extensions/CommunityToolkit.Aspire.Hosting.Redis.Extensions.csproj | Refines description casing/wording for Redis extensions package. |
| src/CommunityToolkit.Aspire.Hosting.PostgreSQL.Extensions/CommunityToolkit.Aspire.Hosting.PostgreSQL.Extensions.csproj | Refines description casing/wording for PostgreSQL extensions package. |
| src/CommunityToolkit.Aspire.Hosting.Perl/CommunityToolkit.Aspire.Hosting.Perl.csproj | Refines description casing/grammar for Perl hosting integration. |
| src/CommunityToolkit.Aspire.Hosting.OpenTelemetryCollector/CommunityToolkit.Aspire.Hosting.OpenTelemetryCollector.csproj | Refines description and punctuation for OpenTelemetry Collector hosting integration (tags should include hosting). |
| src/CommunityToolkit.Aspire.Hosting.MySql.Extensions/CommunityToolkit.Aspire.Hosting.MySql.Extensions.csproj | Refines description casing/wording for MySQL extensions package. |
| src/CommunityToolkit.Aspire.Hosting.MongoDB.Extensions/CommunityToolkit.Aspire.Hosting.MongoDB.Extensions.csproj | Refines description casing/wording for MongoDB extensions package. |
| src/CommunityToolkit.Aspire.Hosting.McpInspector/CommunityToolkit.Aspire.Hosting.McpInspector.csproj | Refines description grammar/clarity for MCP Inspector hosting integration. |
| src/CommunityToolkit.Aspire.Hosting.Elasticsearch.Extensions/CommunityToolkit.Aspire.Hosting.Elasticsearch.Extensions.csproj | Refines description wording for Elasticsearch extensions package. |
| src/CommunityToolkit.Aspire.Hosting.Dbx/CommunityToolkit.Aspire.Hosting.Dbx.csproj | Refines description casing/clarity for Dbx hosting integration. |
| src/CommunityToolkit.Aspire.Hosting.DbGate/CommunityToolkit.Aspire.Hosting.DbGate.csproj | Refines description casing/clarity for DbGate hosting integration. |
| src/CommunityToolkit.Aspire.Hosting.Adminer/CommunityToolkit.Aspire.Hosting.Adminer.csproj | Refines description casing/clarity for Adminer hosting integration. |
Comments suppressed due to low confidence (1)
src/CommunityToolkit.Aspire.Logto.Client/CommunityToolkit.Aspire.Logto.Client.csproj:12
- Indentation is inconsistent with the surrounding
.csprojfiles in this repo (most use 2-space indentation under<Project>). Keeping the standard formatting makes diffs cleaner and easier to review.
<PropertyGroup>
<Description>An Aspire client integration for Logto that registers OpenID Connect (OIDC) or JWT authentication services in the dependency injection container.</Description>
<AdditionalPackageTags>client logto authentication oidc jwt</AdditionalPackageTags>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="Logto.AspNetCore.Authentication" />
<PackageReference Include="Microsoft.Extensions.Configuration.Binder" />
<PackageReference Include="Microsoft.AspNetCore.Authentication.JwtBearer" />
</ItemGroup>
aaronpowell
left a comment
There was a problem hiding this comment.
@copilot can you fix the spelling mistake too
Fixed in commit |
Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>
Co-authored-by: aaronpowell <434140+aaronpowell@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
417384f to
3b79545
Compare
|
All packages shipping from this repo should carry a meaningful
<Description>and package tags, mirroring dotnet/aspire conventions. Two packages shipped with neither, and several existing descriptions were grammatically off or used inconsistent product-name casing.Changes
Description+AdditionalPackageTagstoCommunityToolkit.Aspire.Logto.ClientandCommunityToolkit.Aspire.Hosting.Azure.Dapr.Redis, each describing what the integration actually wraps.mongodb→MongoDB,sqlserver→SQL Server,dbgate→DbGate, …), grammar (An Aspire to run…,An aspire integration…,An Aspire host integration…), and missing trailing periods, clarifying the underlying container/tool where the prior text was vague.Result
All 69 packable projects under
src/now have a non-empty, content-aligned description and tags.Note: a review comment flagged a typo (
authenticatioon) in the Zitadel.csproj— this is a false positive; the text reads "identity and access management container".