Skip to content

Backfill Weave SDK release notes (0.52.38–0.53.4) and add drift-check automation - #3058

Draft
dbrian57 wants to merge 1 commit into
mainfrom
weave-sdk-release-notes-backfill
Draft

Backfill Weave SDK release notes (0.52.38–0.53.4) and add drift-check automation#3058
dbrian57 wants to merge 1 commit into
mainfrom
weave-sdk-release-notes-backfill

Conversation

@dbrian57

@dbrian57 dbrian57 commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

Description

Fixes the Weave SDK release notes page being ~4 months stale (DOCS-3049). The page stopped at 0.52.37 (April 17) while wandb/weave is at v0.53.4 (July 31).

Content

Adds 11 missing <Update> entries (0.52.38–0.52.43, 0.53.0–0.53.4), summarized from the GitHub release PR lists in the page's existing customer-facing style. Internal-only work (tests, CI, refactors, unreleased plumbing) is omitted. Two additions to the page's section vocabulary, motivated by DOCS-1743 (customer request for breaking-change visibility):

  • Breaking changes — 0.52.43 (use_otel_v2 default flip that stopped implicit openai patching; SQLite trace server removal) and 0.53.0 (TS SDK WeaveClient value export removal; settings consolidation).
  • Security — 0.53.4 (trace-server ORM field-qualifier validation).

Automation

  • New weekly workflow .github/workflows/sdk-release-notes-drift.yml runs scripts/check_sdk_release_notes_drift.py; on drift it opens (or updates) a release-notes-drift issue with a table of stale pages, and auto-closes the issue when the pages catch up.
  • The drift script now sends an Authorization header when GITHUB_TOKEN is set, to avoid unauthenticated rate limits on shared runners.

Verification

  • Mintlify build validation passed (validate-mdx-mintlify.sh).
  • Drift check now exits 0 for both wandb/wandb and wandb/weave.
  • Opaque PR titles (e.g. fix(weave): WB-38055) were resolved against PR bodies/diffs rather than guessed; entries are grounded in what each PR says.

Items for SME review

A few judgment calls that a Weave engineer should sanity-check:

  • 0.52.43 Breaking changes: promoted the use_otel_v2 default flip and SQLite trace-server removal to a Breaking changes section even though the upstream PRs weren't marked !.
  • 0.53.4 Fixed: the credential-redaction-at-ingest bullet consolidates three Jira-only PRs (WB-38055/38103/38110); phrased neutrally — confirm comfort level with disclosure.
  • 0.52.38: the pi.dev coding agent integration is documented; all upstream PRs were chore-typed, so confirm it was meant to be announced.
  • 0.52.41/0.52.42: remote-scorer host allowlist/OAuth configuration bullets — confirm Remote Scorers is public enough to reference.
  • 0.53.2 Added: the ingest-sampling bullet notes that deployments with a sample rate below 1.0 start sampling the spans data model after upgrading — worth an SME confirming that operational note is accurate.

🤖 Generated with Claude Code

@dbrian57 @claude
Backfill Weave SDK release notes 0.52.38–0.53.4 and add drift-check w…
d4c78bf 
…orkflow

- Add 11 missing <Update> entries covering May 5 – July 31, 2026, summarized
  from wandb/weave GitHub releases with internal-only changes omitted
- Add Breaking changes and Security sections where releases warrant them
- Add a weekly GitHub Actions workflow that runs
  scripts/check_sdk_release_notes_drift.py and opens/updates a tracking
  issue when a docs page falls behind the newest GitHub release
- Authenticate the drift script's GitHub API calls when GITHUB_TOKEN is set

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@mintlify

mintlify Bot commented Aug 11, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
wandb 🟢 Ready View Preview Aug 11, 2026, 6:53 PM

@w-b-hivemind

w-b-hivemind Bot commented Aug 11, 2026 •
edited
Loading

Copy link
Copy Markdown

HiveMind Sessions

1 session · 33m · $10

Session Agent Duration Tokens Cost Lines
Automate Weave SDK Release Notes Generation
af0aa935-7233-4c8f-8e98-8c80dfd4f33a		 claude 33m 40.2K $10 +203 -11
Total 33m 40.2K $10 +203 -11

View all sessions in HiveMind →

Run claude --resume af0aa935-7233-4c8f-8e98-8c80dfd4f33a to pickup where you left off.

@github-actions

github-actions Bot commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

Readability impact

Word-weighted Flesch-Kincaid grade change across 1 changed page: +0.5 (harder).

Lower Flesch-Kincaid grade and higher reading ease both mean easier to read. This check is informational and never blocks a PR.

Human readability

Page FK grade before FK grade after FK Δ Reading ease Δ Direction
release-notes/weave-sdk-releases.mdx 9.4 9.9 +0.5 +2.9 harder

AI agent comprehension

Rated 0-3 (higher is easier for an agent to parse and act on).

Page Before After Δ
release-notes/weave-sdk-releases.mdx 2 2 +0

Curated-docs baseline median FK grade by type: conceptual 10.5, procedural 8.8, reference 9.4.

From workflow run 31524739312

@github-actions

github-actions Bot commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

📚 Mintlify Preview Links

🔗 View Full Preview

📝 Changed (1 total)

📄 Pages (1)

File Preview
release-notes/weave-sdk-releases.mdx Weave Sdk Releases

🤖 Generated automatically when Mintlify deployment succeeds
📍 Deployment: d4c78bf at 2026-08-11 18:53:46 UTC

@github-actions

github-actions Bot commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

🔗 Link Checker Results

✅ All links are valid!

No broken links were detected.

Preview: https://wb-21fd5541-weave-sdk-release-notes-backfill.mintlify.site/release-notes/weave-sdk-releases

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@dbrian57