Skip to content

Harden the release pipeline and document the generated surface - #6

Merged
sbokatuk merged 3 commits into
mainfrom
ergonomics-and-usability
Jul 24, 2026
Merged

sbokatuk merged 3 commits into
mainfrom
ergonomics-and-usability

Conversation

@sbokatuk

Copy link
Copy Markdown
Owner
  • README: fix the stale 3.14.0.1 install pins, and fail CI when README versions drift from Directory.Build.props (build/CheckReadmeVersions.sh)
  • Pack the curated docs/release-notes/.md into PackageReleaseNotes, with the releases page as fallback, so nuget.org stops showing empty notes
  • Document why DDLogger's error/attributes parameters carry no [NullAllowed]: upstream declares them _Nonnull and the Swift implementation takes a non-optional [String: Any], so letting null through would trade today's managed ArgumentNullException for a native crash. The README's troubleshooting section points at the null-tolerant Log(...) instead.
  • Add doc summaries to the 26 main entry types in the ApiDefinitions files; the binding generator carries them into the packages' XML docs (measured, not assumed), so DDDatadog, DDConfiguration, the per-module Enable types, DDRUMMonitor, DDLogger and the header writers now have IntelliSense
  • Turn the trim and AOT analyzers on permanently; the whole surface analyses clean today, and IsTrimmable stays deliberately unset - the props explain
  • Add build/DiffSwiftHeaders.sh and docs/regenerating-bindings.md: the header diff is the upgrade work list while Objective Sharpie cannot regenerate, and the script also yields the SHA-256 checksums.txt records
  • Document the net8 sunset: dropped in the first release after .NET 8 leaves support on 10 November 2026

sbokatuk and others added 2 commits July 24, 2026 11:17
- README: fix the stale 3.14.0.1 install pins, and fail CI when README
  versions drift from Directory.Build.props (build/CheckReadmeVersions.sh)
- Pack the curated docs/release-notes/<version>.md into PackageReleaseNotes,
  with the releases page as fallback, so nuget.org stops showing empty notes
- Document why DDLogger's error/attributes parameters carry no [NullAllowed]:
  upstream declares them _Nonnull and the Swift implementation takes a
  non-optional [String: Any], so letting null through would trade today's
  managed ArgumentNullException for a native crash. The README's
  troubleshooting section points at the null-tolerant Log(...) instead.
- Add doc summaries to the 26 main entry types in the ApiDefinitions files;
  the binding generator carries them into the packages' XML docs (measured,
  not assumed), so DDDatadog, DDConfiguration, the per-module Enable types,
  DDRUMMonitor, DDLogger and the header writers now have IntelliSense
- Turn the trim and AOT analyzers on permanently; the whole surface analyses
  clean today, and IsTrimmable stays deliberately unset - the props explain
- Add build/DiffSwiftHeaders.sh and docs/regenerating-bindings.md: the
  header diff is the upgrade work list while Objective Sharpie cannot
  regenerate, and the script also yields the SHA-256 checksums.txt records
- Document the net8 sunset: dropped in the first release after .NET 8
  leaves support on 10 November 2026

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Version bump, README pins to match (now CI-enforced), and the curated
release notes - which this release is the first to surface on nuget.org
through PackageReleaseNotes.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
DatadogNet.WebViewTracking.iOS joins the sample - the one package with a
callable API that nothing exercised - with a tracked WKWebView page and a
README usage section to match. A button makes an instrumented NSUrlSession
request through the generic Enable<TDelegate>(), the automatic path the
sample only ever showed manually, and another toggles a per-view Session
Replay privacy override. Release notes extended accordingly.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@sbokatuk
sbokatuk merged commit 3cd7057 into main Jul 24, 2026
6 checks passed
@sbokatuk
sbokatuk deleted the ergonomics-and-usability branch July 24, 2026 10:18

This branch was previously deployed

1 inactive deployment
nuget.org — 864dfbc8 Deployed Jul 24, 2026 by sbokatuk via publish beta to nuget.org #15
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