From 32aa4a088a29641b704d91b46643ecfdcba17262 Mon Sep 17 00:00:00 2001 From: Widthdom Date: Mon, 25 May 2026 03:59:10 +0900 Subject: [PATCH] Fix NuGet README release links --- .../unreleased/+nuget-readme-tag-links.fixed.md | 14 ++++++++++++++ docs/NUGET_README.md | 14 +++++++------- src/CodeIndex/CodeIndex.csproj | 15 +++++++++++++-- 3 files changed, 34 insertions(+), 9 deletions(-) create mode 100644 changelog.d/unreleased/+nuget-readme-tag-links.fixed.md diff --git a/changelog.d/unreleased/+nuget-readme-tag-links.fixed.md b/changelog.d/unreleased/+nuget-readme-tag-links.fixed.md new file mode 100644 index 0000000000..2a1608cdde --- /dev/null +++ b/changelog.d/unreleased/+nuget-readme-tag-links.fixed.md @@ -0,0 +1,14 @@ +--- +category: fixed +affected: + - docs/NUGET_README.md + - src/CodeIndex/CodeIndex.csproj +--- + +## English + +- **NuGet README links now point at the packaged release tag** - NuGet package README and release-note links are generated with the package version tag instead of `main`, so older package pages keep pointing at matching documentation. + +## 日本語 + +- **NuGet README のリンクがパッケージ対象のリリースタグを指すようになりました** - NuGet package README と release note のリンクは `main` ではなくパッケージ version のタグで生成されるため、過去バージョンの package page から対応する documentation を参照できます。 diff --git a/docs/NUGET_README.md b/docs/NUGET_README.md index 563b2e2f17..9406c019ea 100644 --- a/docs/NUGET_README.md +++ b/docs/NUGET_README.md @@ -28,13 +28,13 @@ absolute GitHub URLs. | Document | Link | |---|---| -| README | https://github.com/Widthdom/CodeIndex/blob/main/README.md | -| User Guide | https://github.com/Widthdom/CodeIndex/blob/main/USER_GUIDE.md | -| Platform Support | https://github.com/Widthdom/CodeIndex/blob/main/docs/platform-support.md | -| Developer Guide | https://github.com/Widthdom/CodeIndex/blob/main/DEVELOPER_GUIDE.md | -| Integration Policy | https://github.com/Widthdom/CodeIndex/blob/main/INTEGRATION_POLICY.md | -| Security Policy | https://github.com/Widthdom/CodeIndex/blob/main/SECURITY.md | -| Changelog | https://github.com/Widthdom/CodeIndex/blob/main/CHANGELOG.md | +| README | https://github.com/Widthdom/CodeIndex/blob/{{RELEASE_REF}}/README.md | +| User Guide | https://github.com/Widthdom/CodeIndex/blob/{{RELEASE_REF}}/USER_GUIDE.md | +| Platform Support | https://github.com/Widthdom/CodeIndex/blob/{{RELEASE_REF}}/docs/platform-support.md | +| Developer Guide | https://github.com/Widthdom/CodeIndex/blob/{{RELEASE_REF}}/DEVELOPER_GUIDE.md | +| Integration Policy | https://github.com/Widthdom/CodeIndex/blob/{{RELEASE_REF}}/INTEGRATION_POLICY.md | +| Security Policy | https://github.com/Widthdom/CodeIndex/blob/{{RELEASE_REF}}/SECURITY.md | +| Changelog | https://github.com/Widthdom/CodeIndex/blob/{{RELEASE_REF}}/CHANGELOG.md | `cdidx` is distributed as a CLI and MCP server only. The NuGet package is a global tool package and does not provide a public library or SDK API. diff --git a/src/CodeIndex/CodeIndex.csproj b/src/CodeIndex/CodeIndex.csproj index 5cf96f8c85..1fc1314176 100644 --- a/src/CodeIndex/CodeIndex.csproj +++ b/src/CodeIndex/CodeIndex.csproj @@ -36,7 +36,10 @@ https://github.com/widthdom/codeindex https://github.com/widthdom/codeindex git - See https://github.com/Widthdom/CodeIndex/blob/main/CHANGELOG.md for release notes. + v$(Version) + $([System.IO.Path]::Combine('$(MSBuildProjectDirectory)', '..', '..', 'docs', 'NUGET_README.md')) + $([System.IO.Path]::Combine('$(MSBuildProjectDirectory)', 'obj', 'NuGet', 'NUGET_README.md')) + See https://github.com/Widthdom/CodeIndex/blob/$(NuGetReleaseRef)/CHANGELOG.md for release notes. NUGET_README.md cdidx-icon.png @@ -115,8 +118,16 @@ + + + + + - +