Skip to content

docs: add NuGetKeep cross-promo footer to the packed README - #193

Open
phmatray wants to merge 1 commit into
devfrom
docs/nugetkeep-footer-packed-readme
Open

phmatray wants to merge 1 commit into
devfrom
docs/nugetkeep-footer-packed-readme

Conversation

@phmatray

@phmatray phmatray commented Oct 1, 2026

Copy link
Copy Markdown
Contributor

Why

A package's README on nuget.org is frozen per published version. The portfolio-nugetkeep footer exists in 38 repository READMEs but is only visible on 1 of 30 package pages on nuget.org (RoselineMCP, 1.2% of total downloads), because every other package last shipped before the footer landed.

This repo was not one of the 38 — it had no footer at all.

What this changes

Appends the existing footer to README.md, which is the file packed into the Atypical.VirtualFileSystem package. Verified, not assumed:

  • src/Atypical.VirtualFileSystem.Core/Atypical.VirtualFileSystem.Core.csproj:15 → <None Include="../../README.md" Pack="true" PackagePath="" />
  • same file:32 → <PackageReadmeFile>README.md</PackageReadmeFile>
  • the published Atypical.VirtualFileSystem 0.3.0 nuspec declares <readme>README.md</readme>

The footer is byte-identical to the one in the other repos — same <!-- portfolio-nugetkeep:start --> / :end markers, same UTM values (utm_source=github-readme&utm_medium=readme&utm_campaign=launch-2026-07). 316 bytes appended, no existing prose touched, no copy rewritten.

The UTM values must stay exactly as-is: utm_medium=readme is what segments this channel in Umami. A drifted parameter silently destroys the channel's ability to report its own conversion rate.

This does not publish anything

Merging this changes nothing on nuget.org. The footer only reaches the package page when a new version is published, and that is gated on Philippe's explicit approval.

Two things to know before any such release:

  • A README-only release here would be 0.3.1. CI publishes on a pushed v* tag via .github/workflows/publish-to-nuget.yml, version derived from the tag.
  • ⚠️ There is a version gap. Directory.Build.props:13 says <Version>0.5.0</Version> and tag v0.5.0 exists, but nuget.org's latest is 0.3.0 — the v0.4.x/v0.5.0 tags did not publish. Worth understanding before tagging anything, or the next tag fails the same silent way.

No version bump is included in this PR.

Part of ATY-50.

The package README on nuget.org is frozen per published version. This README
is the one packed into Atypical.VirtualFileSystem (<None Include="../../README.md"
Pack="true" /> in src/Atypical.VirtualFileSystem.Core/*.csproj:15), so the
footer reaches the package page on the next release.

Footer is byte-identical to the existing one in 38 other repo READMEs, same
<!-- portfolio-nugetkeep:start --> markers and same UTM values. No copy changed.

Co-Authored-By: Paperclip <noreply@paperclip.ing>

This branch has not been deployed

No deployments
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.

1 participant