Skip to content

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

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

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

Conversation

@phmatray

@phmatray phmatray commented Oct 1, 2026

Copy link
Copy Markdown
Contributor

Adds the shared portfolio-nugetkeep cross-promo footer to the repo root README.md.

Why this file

README.md at the repo root is the README that Atypical.VirtualFileSystem.Core actually packs:

<None Include="../../README.md" Pack="true" PackagePath="" />
...
<PackageReadmeFile>README.md</PackageReadmeFile>

(src/Atypical.VirtualFileSystem.Core/Atypical.VirtualFileSystem.Core.csproj, lines 15 and 32.)

So this is the file whose content reaches the nuget.org package page — editing anything else would not.

What the footer is

The same block already present in the other repos in this rollout, byte-identical. The sha256 of the inserted block is 1e14ebfac7a61dfe4e86981c1c3913b0140f1f728d6b9938723b7ae7604192d9. It is delimited by <!-- portfolio-nugetkeep:start --> / <!-- portfolio-nugetkeep:end --> so it can be updated or removed mechanically later.

What the next release would change

Merging this PR publishes nothing. .github/workflows/publish-to-nuget.yml is triggered only by push: tags: v*, so no package is pushed to nuget.org by this merge.

The next time a v* tag is cut and that workflow runs, the packed Atypical.VirtualFileSystem.Core nupkg would contain this README, and the nuget.org package page for Atypical.VirtualFileSystem.Core would render the extra footer paragraph at the bottom. That is the only change — no code, no API surface, no package metadata, no version bump in this PR.

Cutting that release is a separate, human-gated step and is not requested here.

Scope

  • 1 file, 7 added lines, 0 removed.
  • No source, test, build, or workflow changes.

Atypical.VirtualFileSystem packs the repo root README via
<None Include="../../README.md" Pack="true" /> in
src/Atypical.VirtualFileSystem.Core/Atypical.VirtualFileSystem.Core.csproj.

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