Skip to content

fix: exclude documentation files from NuGet package builds#263

Merged
jsonbailey merged 4 commits into
mainfrom
devin/1779486323-exclude-docs-from-pack
May 27, 2026
Merged

fix: exclude documentation files from NuGet package builds#263
jsonbailey merged 4 commits into
mainfrom
devin/1779486323-exclude-docs-from-pack

Conversation

@kinyoklion

@kinyoklion kinyoklion commented May 22, 2026

Copy link
Copy Markdown
Member

Requirements

  • I have added test coverage for new or changed functionality
  • I have followed the repository's pull request submission guidelines
  • I have validated my changes against all supported platform versions

Related issues

Closes #261

Describe the solution you've provided

  • Changed documentation file items from <Content> to <None> in all package .csproj files so they are not copied to consuming project bin folders.
  • Pack README.md into each NuGet package (with <PackageReadmeFile> and <PackagePath>\</PackagePath>) so it renders on the NuGet.org package page.
  • All other doc files (CHANGELOG, docfx.json, etc.) use <Pack>false</Pack> to exclude them from packages.
  • Created a new README.md for the Telemetry package (which previously had none).

Describe alternatives you've considered

Originally used <Content> with <Pack>false</Pack>, but switched to <None> per NuGet best practices to avoid files being copied to consuming projects.

Additional context

Reference: https://devblogs.microsoft.com/dotnet/add-a-readme-to-your-nuget-package/

Link to Devin session: https://app.devin.ai/sessions/9ab235b0b6af4361a2b4e9cec502b3f5
Requested by: @kinyoklion


Note

Low Risk
MSBuild/NuGet packaging-only changes; no SDK runtime, auth, or public API behavior is modified.

Overview
Across LaunchDarkly .NET SDK and integration packages, linked repo docs (CHANGELOG, CONTRIBUTING, docfx.json, index.md, etc.) move from <Content> to <None> with <Pack>false</Pack> so they stay in the solution without being copied into consuming apps’ output or bundled into the .nupkg.

README is wired for NuGet.org via <PackageReadmeFile>README.md</PackageReadmeFile> plus a packed README.md at the package root (<Pack>true</Pack>, <PackagePath>\</PackagePath>). Integration packages (Consul, DynamoDB, Redis) and Telemetry follow the same pattern; Telemetry also gains a new pkgs/telemetry/README.md and packs it in LaunchDarkly.ServerSdk.Telemetry.csproj.

Client SDK additionally stops packing toc.yml (explicit <Pack>false</Pack>). No runtime or API code changes—only packaging metadata.

Reviewed by Cursor Bugbot for commit cf34018. Bugbot is set up for automated code reviews on this repo. Configure here.

Co-Authored-By: rlamb@launchdarkly.com <4955475+kinyoklion@users.noreply.github.com>
@devin-ai-integration

Copy link
Copy Markdown
Contributor

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@devin-ai-integration devin-ai-integration Bot added the devin-pr PR was created by Devin AI label May 22, 2026
@kinyoklion kinyoklion changed the title chore: exclude documentation files from NuGet package builds fix: exclude documentation files from NuGet package builds May 22, 2026
Comment thread pkgs/dotnet-server-sdk-consul/src/LaunchDarkly.ServerSdk.Consul.csproj Outdated
devin-ai-integration Bot and others added 2 commits May 26, 2026 22:13
@kinyoklion kinyoklion marked this pull request as ready for review May 26, 2026 22:33
@kinyoklion kinyoklion requested a review from a team as a code owner May 26, 2026 22:33

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes using default effort and found 1 potential issue.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, have a team admin enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit b53259a. Configure here.

Comment thread pkgs/telemetry/src/LaunchDarkly.ServerSdk.Telemetry.csproj
Co-Authored-By: rlamb@launchdarkly.com <4955475+kinyoklion@users.noreply.github.com>
@jsonbailey jsonbailey merged commit cc86ad6 into main May 27, 2026
26 of 28 checks passed
@jsonbailey jsonbailey deleted the devin/1779486323-exclude-docs-from-pack branch May 27, 2026 16:20
kinyoklion pushed a commit that referenced this pull request May 27, 2026
🤖 I have created a release *beep* *boop*
---


##
[5.7.3](LaunchDarkly.ClientSdk-v5.7.2...LaunchDarkly.ClientSdk-v5.7.3)
(2026-05-27)


### Bug Fixes

* exclude documentation files from NuGet package builds
([#263](#263))
([cc86ad6](cc86ad6))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> **Low Risk**
> Release-metadata-only PR with no application or SDK runtime code
changes in the diff.
> 
> **Overview**
> Release Please bumps **LaunchDarkly.ClientSdk** from **5.7.2** to
**5.7.3** across the release manifest, `LaunchDarkly.ClientSdk.csproj`,
`PROVENANCE.md`, and `CHANGELOG.md`.
> 
> The release notes document a **patch** fix from
[#263](#263):
documentation files are excluded from NuGet package builds. This PR does
not include that packaging change—only the version and release metadata
updates.
> 
> <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit
633c2d3. Bugbot is set up for automated
code reviews on this repo. Configure
[here](https://www.cursor.com/dashboard/bugbot).</sup>
<!-- /CURSOR_SUMMARY -->

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
kinyoklion pushed a commit that referenced this pull request May 27, 2026
🤖 I have created a release *beep* *boop*
---


##
[8.12.2](LaunchDarkly.ServerSdk-v8.12.1...LaunchDarkly.ServerSdk-v8.12.2)
(2026-05-27)


### Bug Fixes

* exclude documentation files from NuGet package builds
([#263](#263))
([cc86ad6](cc86ad6))
* use basis query param for FDv2 polling selector
([#260](#260))
([abaee9d](abaee9d))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> **Low Risk**
> Automated version and changelog updates only; functional fixes are
described in the changelog but not introduced in this diff.
> 
> **Overview**
> Release Please bumps **LaunchDarkly.ServerSdk** from **8.12.1** to
**8.12.2** across the manifest, `LaunchDarkly.ServerSdk.csproj`,
`PROVENANCE.md`, and a new **CHANGELOG** section dated 2026-05-27.
> 
> The release notes two bug fixes already landed on main: **NuGet**
builds no longer pack repo documentation files (`Pack>false` on doc
assets in the csproj), and **FDv2** polling uses the **`basis`** query
parameter on the polling selector (see `FDv2PollingRequestor`). This PR
does not change SDK source beyond the version string.
> 
> <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit
0e2a793. Bugbot is set up for automated
code reviews on this repo. Configure
[here](https://www.cursor.com/dashboard/bugbot).</sup>
<!-- /CURSOR_SUMMARY -->

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
kinyoklion pushed a commit that referenced this pull request May 27, 2026
🤖 I have created a release *beep* *boop*
---


##
[5.0.1](LaunchDarkly.ServerSdk.DynamoDB-v5.0.0...LaunchDarkly.ServerSdk.DynamoDB-v5.0.1)
(2026-05-27)


### Bug Fixes

* exclude documentation files from NuGet package builds
([#263](#263))
([cc86ad6](cc86ad6))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> **Low Risk**
> Version and release-metadata only; no application or SDK behavior
changes in this diff.
> 
> **Overview**
> This PR is a **Release Please** cut that publishes
**`LaunchDarkly.ServerSdk.DynamoDB` 5.0.1** by bumping the package
version everywhere release automation expects it.
> 
> The diff updates `.release-please-manifest.json`, the `<Version>` in
`LaunchDarkly.ServerSdk.DynamoDB.csproj`, the new **5.0.1** section in
`CHANGELOG.md`, and the `SDK_VERSION` example in `PROVENANCE.md`. There
is **no runtime or integration logic** in the diff itself; the changelog
notes the release includes the fix from
[#263](#263) to
**exclude documentation files from NuGet package builds** (already
landed on the branch this release tags).
> 
> <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit
06128e7. Bugbot is set up for automated
code reviews on this repo. Configure
[here](https://www.cursor.com/dashboard/bugbot).</sup>
<!-- /CURSOR_SUMMARY -->

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
kinyoklion pushed a commit that referenced this pull request May 27, 2026
🤖 I have created a release *beep* *boop*
---


##
[0.9.4](LaunchDarkly.ServerSdk.Ai-v0.9.3...LaunchDarkly.ServerSdk.Ai-v0.9.4)
(2026-05-27)


### Bug Fixes

* exclude documentation files from NuGet package builds
([#263](#263))
([cc86ad6](cc86ad6))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> **Low Risk**
> Mechanical version and changelog updates from Release Please; no
application logic changes in this diff.
> 
> **Overview**
> **Release Please** cuts **LaunchDarkly.ServerSdk.Ai** from **0.9.3**
to **0.9.4** by updating `.release-please-manifest.json`,
`LaunchDarkly.ServerSdk.Ai.csproj`, `SdkInfo.Version`, `PROVENANCE.md`,
and a new **CHANGELOG** section.
> 
> The release notes attribute the version to a **bug fix** (already
landed on main): **documentation and doc-build files are no longer
packed into the NuGet** (e.g. `Pack=false` on
changelog/contributing/docfx paths in the csproj, per
[#263](#263)). This PR
does not change runtime SDK behavior—only release metadata and published
package contents for the next NuGet publish.
> 
> <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit
642f092. Bugbot is set up for automated
code reviews on this repo. Configure
[here](https://www.cursor.com/dashboard/bugbot).</sup>
<!-- /CURSOR_SUMMARY -->

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
kinyoklion pushed a commit that referenced this pull request May 27, 2026
🤖 I have created a release *beep* *boop*
---


##
[5.1.1](LaunchDarkly.ServerSdk.Redis-v5.1.0...LaunchDarkly.ServerSdk.Redis-v5.1.1)
(2026-05-27)


### Bug Fixes

* exclude documentation files from NuGet package builds
([#263](#263))
([cc86ad6](cc86ad6))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> **Low Risk**
> Automated version and documentation updates with no runtime or API
changes in the diff.
> 
> **Overview**
> **Release Please** bumps **LaunchDarkly.ServerSdk.Redis** from
**5.1.0** to **5.1.1** in `.release-please-manifest.json`,
`LaunchDarkly.ServerSdk.Redis.csproj`, `PROVENANCE.md`, and adds a
**5.1.1** changelog entry.
> 
> The noted fix is excluding documentation files from NuGet package
builds ([#263]); this PR does not change project or packaging logic—only
version and release metadata.
> 
> <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit
dd28f4c. Bugbot is set up for automated
code reviews on this repo. Configure
[here](https://www.cursor.com/dashboard/bugbot).</sup>
<!-- /CURSOR_SUMMARY -->

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
kinyoklion pushed a commit that referenced this pull request May 27, 2026
🤖 I have created a release *beep* *boop*
---


##
[1.5.1](LaunchDarkly.ServerSdk.Telemetry-v1.5.0...LaunchDarkly.ServerSdk.Telemetry-v1.5.1)
(2026-05-27)


### Bug Fixes

* exclude documentation files from NuGet package builds
([#263](#263))
([cc86ad6](cc86ad6))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> **Low Risk**
> Version and release-metadata only; no runtime or API changes in this
diff.
> 
> **Overview**
> **Release Please** bumps **LaunchDarkly.ServerSdk.Telemetry** from
**1.5.0** to **1.5.1** across the manifest,
`LaunchDarkly.ServerSdk.Telemetry.csproj`, `PROVENANCE.md`, and a new
**CHANGELOG** entry.
> 
> The release documents the bug fix from
[#263](#263):
documentation assets (e.g. `CHANGELOG.md`, `docfx.json`, `index.md`) are
no longer included in the NuGet package—only `README.md` remains packed
for consumers.
> 
> <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit
6a9d0f2. Bugbot is set up for automated
code reviews on this repo. Configure
[here](https://www.cursor.com/dashboard/bugbot).</sup>
<!-- /CURSOR_SUMMARY -->

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
kinyoklion pushed a commit that referenced this pull request May 27, 2026
🤖 I have created a release *beep* *boop*
---


##
[5.0.1](LaunchDarkly.ServerSdk.Consul-v5.0.0...LaunchDarkly.ServerSdk.Consul-v5.0.1)
(2026-05-27)


### Bug Fixes

* exclude documentation files from NuGet package builds
([#263](#263))
([cc86ad6](cc86ad6))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> **Low Risk**
> Version and release-metadata updates only; no runtime or API changes
in this diff.
> 
> **Overview**
> **Release 5.0.1** for `LaunchDarkly.ServerSdk.Consul` bumps the
package version everywhere Release Please tracks it:
`.release-please-manifest.json`, `LaunchDarkly.ServerSdk.Consul.csproj`,
`CHANGELOG.md`, and `PROVENANCE.md` verification examples.
> 
> The changelog records a **patch** fix from
[#263](#263):
documentation files are excluded from NuGet package builds. This PR does
not include that packaging change—only the automated version and release
notes for the already-merged fix.
> 
> <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit
9812e8f. Bugbot is set up for automated
code reviews on this repo. Configure
[here](https://www.cursor.com/dashboard/bugbot).</sup>
<!-- /CURSOR_SUMMARY -->

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
abelonogov-ld added a commit that referenced this pull request May 27, 2026
…y/dotnet-core into andrey/register-plugin

* 'andrey/register-plugin' of ssh://github.com/launchdarkly/dotnet-core:
  chore(main): release LaunchDarkly.ServerSdk 8.13.0 (#273)
  chore(main): release LaunchDarkly.ServerSdk.Consul 5.0.1 (#270)
  chore(main): release LaunchDarkly.ServerSdk.Telemetry 1.5.1 (#268)
  chore(main): release LaunchDarkly.ServerSdk.Redis 5.1.1 (#267)
  feat: add X-LaunchDarkly-Instance-Id header (#258)
  chore(main): release LaunchDarkly.ServerSdk.Ai 0.9.4 (#271)
  chore(main): release LaunchDarkly.ServerSdk.DynamoDB 5.0.1 (#269)
  chore(main): release LaunchDarkly.ServerSdk 8.12.2 (#262)
  chore(main): release LaunchDarkly.ClientSdk 5.7.3 (#272)
  fix: exclude documentation files from NuGet package builds (#263)
evgenygunko pushed a commit to evgenygunko/CopyWordsDA that referenced this pull request May 28, 2026
This PR contains the following updates:

| Package | Change | [Age](https://docs.renovatebot.com/merge-confidence/) | [Confidence](https://docs.renovatebot.com/merge-confidence/) |
|---|---|---|---|
| [LaunchDarkly.ClientSdk](https://github.com/launchdarkly/dotnet-core) | `5.7.2` → `5.8.0` | ![age](https://developer.mend.io/api/mc/badges/age/nuget/LaunchDarkly.ClientSdk/5.8.0?slim=true) | ![confidence](https://developer.mend.io/api/mc/badges/confidence/nuget/LaunchDarkly.ClientSdk/5.7.2/5.8.0?slim=true) |

---

### Release Notes

<details>
<summary>launchdarkly/dotnet-core (LaunchDarkly.ClientSdk)</summary>

### [`v5.8.0`](https://github.com/launchdarkly/dotnet-core/releases/tag/LaunchDarkly.ClientSdk-v5.8.0): LaunchDarkly.ClientSdk: v5.8.0

[Compare Source](launchdarkly/dotnet-core@LaunchDarkly.ClientSdk-v5.7.3...LaunchDarkly.ClientSdk-v5.8.0)

##### Features

- Allow register plugins dynamically  ([#&#8203;266](launchdarkly/dotnet-core#266)) ([547e518](launchdarkly/dotnet-core@547e518))

***

This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).

<!-- CURSOR_SUMMARY -->

### [`v5.7.3`](https://github.com/launchdarkly/dotnet-core/releases/tag/LaunchDarkly.ClientSdk-v5.7.3): LaunchDarkly.ClientSdk: v5.7.3

[Compare Source](launchdarkly/dotnet-core@LaunchDarkly.ClientSdk-v5.7.2...LaunchDarkly.ClientSdk-v5.7.3)

##### Bug Fixes

- exclude documentation files from NuGet package builds ([#&#8203;263](launchdarkly/dotnet-core#263)) ([cc86ad6](launchdarkly/dotnet-core@cc86ad6))

***

This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).

<!-- CURSOR_SUMMARY -->

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or PR is renamed to start with "rebase!".

👻 **Immortal**: This PR will be recreated if closed unmerged. Get [config help](https://github.com/renovatebot/renovate/discussions) if that's undesired.

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
evgenygunko pushed a commit to evgenygunko/Translations that referenced this pull request May 28, 2026
This PR contains the following updates:

| Package | Change | [Age](https://docs.renovatebot.com/merge-confidence/) | [Confidence](https://docs.renovatebot.com/merge-confidence/) |
|---|---|---|---|
| [LaunchDarkly.ServerSdk](https://github.com/launchdarkly/dotnet-core) | `8.12.1` → `8.13.0` | ![age](https://developer.mend.io/api/mc/badges/age/nuget/LaunchDarkly.ServerSdk/8.13.0?slim=true) | ![confidence](https://developer.mend.io/api/mc/badges/confidence/nuget/LaunchDarkly.ServerSdk/8.12.1/8.13.0?slim=true) |

---

### Release Notes

<details>
<summary>launchdarkly/dotnet-core (LaunchDarkly.ServerSdk)</summary>

### [`v8.13.0`](https://github.com/launchdarkly/dotnet-core/releases/tag/LaunchDarkly.ServerSdk-v8.13.0): LaunchDarkly.ServerSdk: v8.13.0

[Compare Source](launchdarkly/dotnet-core@LaunchDarkly.ServerSdk-v8.12.2...LaunchDarkly.ServerSdk-v8.13.0)

##### Features

- add X-LaunchDarkly-Instance-Id header ([#&#8203;258](launchdarkly/dotnet-core#258)) ([3c03ec4](launchdarkly/dotnet-core@3c03ec4))

***

This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).

<!-- CURSOR_SUMMARY -->

### [`v8.12.2`](https://github.com/launchdarkly/dotnet-core/releases/tag/LaunchDarkly.ServerSdk-v8.12.2): LaunchDarkly.ServerSdk: v8.12.2

[Compare Source](launchdarkly/dotnet-core@LaunchDarkly.ServerSdk-v8.12.1...LaunchDarkly.ServerSdk-v8.12.2)

##### Bug Fixes

- exclude documentation files from NuGet package builds ([#&#8203;263](launchdarkly/dotnet-core#263)) ([cc86ad6](launchdarkly/dotnet-core@cc86ad6))
- use basis query param for FDv2 polling selector ([#&#8203;260](launchdarkly/dotnet-core#260)) ([abaee9d](launchdarkly/dotnet-core@abaee9d))

***

This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).

<!-- CURSOR_SUMMARY -->

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or PR is renamed to start with "rebase!".

👻 **Immortal**: This PR will be recreated if closed unmerged. Get [config help](https://github.com/renovatebot/renovate/discussions) if that's undesired.

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

devin-pr PR was created by Devin AI

Projects

None yet

Development

Successfully merging this pull request may close these issues.

LaunchDarkly.ServerSdk 8.11.0 or later adds a lot of unwanted files

3 participants