Skip to content

[codex] Fix NuGet README release links - #2660

Merged
Widthdom merged 2 commits into
mainfrom
codex/nuget-readme-tag-links
May 24, 2026
Merged

[codex] Fix NuGet README release links#2660
Widthdom merged 2 commits into
mainfrom
codex/nuget-readme-tag-links

Conversation

@Widthdom

Copy link
Copy Markdown
Owner

Summary

  • Generate the NuGet package README from docs/NUGET_README.md at pack time.
  • Replace the README template placeholder with the package version tag, so NuGet pages link to matching release documentation instead of latest main.
  • Point package release notes at the same version tag and add a changelog fragment.

Validation

  • dotnet pack src/CodeIndex/CodeIndex.csproj --configuration Release --no-restore --output /private/tmp/cdidx-pack-check
  • unzip -p /private/tmp/cdidx-pack-check/cdidx.1.24.5.nupkg NUGET_README.md confirmed documentation links use v1.24.5.
  • unzip -p /private/tmp/cdidx-pack-check/cdidx.1.24.5.nupkg cdidx.nuspec confirmed release notes use v1.24.5.
  • dotnet run --project tools/CodeIndex.Changelog -- check

Documentation and changelog

  • Added changelog.d/unreleased/+nuget-readme-tag-links.fixed.md.
  • Updated docs/NUGET_README.md to use the release-ref template placeholder.

Follow-up candidates

  • None.

@Widthdom
Widthdom marked this pull request as ready for review May 24, 2026 19:15
@Widthdom
Widthdom merged commit 30a549c into main May 24, 2026
11 checks passed
@Widthdom
Widthdom deleted the codex/nuget-readme-tag-links branch May 24, 2026 19:57
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