Skip to content

docs(release): prepare the 0.2.1 changelog and upgrade guide - #877

Merged
EricAndrechek merged 7 commits into
mainfrom
docs/release-0.2.1
Oct 21, 2026
Merged

docs(release): prepare the 0.2.1 changelog and upgrade guide#877
EricAndrechek merged 7 commits into
mainfrom
docs/release-0.2.1

Conversation

@EricAndrechek

@EricAndrechek EricAndrechek commented Oct 21, 2026

Copy link
Copy Markdown
Member

Summary

Prepares the 0.2.1 server release, following 0.2.0's pattern (#821): the tag goes on this PR's merge commit.

  • CHANGELOG.md: Unreleased becomes ## [0.2.1] - 2026-10-21, opening with a short upgrade summary, and a fresh empty Unreleased goes above it. The footer gains the [0.2.1] link.

  • docs/src/content/docs/upgrading.md: a new "From 0.2.0 to 0.2.1" section. It is a binary swap with six possible actions:

    • list every proxy that sends X-Forwarded-For or traceparent in server.trusted_proxies, which now decides both the span's client.address and whether a trace is joined;
    • use the container image or go install on a non-Linux host, since the release ships Linux binaries only;
    • replace any endpoint certificate that chains through an intermediate Go 1.26.10 distrusts;
    • filter wavehouse_sse_dropped_frames_total on reason="buffer_full" to keep its old meaning;
    • check the OpenTelemetry environment: service.name from the environment now overrides wavehouse, and service.instance.id is fresh every boot unless instance_id is set;
    • check what the log backend receives: OTLP log export now honors WH_LOG_LEVEL, request-scoped records carry the client's IP as client.address, and every SSE stream logs its opening and closing.

    The section also has a note on the new DynamoDB dedupe layout, which needs no action for existing tables, a rollback note (0.2.0 refuses the four new boot keys and variables), and a Versions list (ClickHouse 26.6, external NATS 2.14+ with 2.15 recommended, Go 1.26.10).

  • Smaller fixes: the /health and /ready aliases now read "still served in 0.2.1", and the settings page says the pkg/ packages are public from v0.2.1.

The SDK is not part of this release. Since clients/ts/v0.2.0, only its dev dependencies changed, so @wavehouse/sdk stays at 0.2.0, and the page says so.

Test plan

  • make verify and make ci
  • Six docs-review rounds of the new text against the code (current and v0.2.0), with every finding fixed. The last commit only shortens the certificate step, and it was not reviewed again, at the maintainer's request. Anything further goes to a follow-up PR.

Related Issues

Release prep; no issue.

🤖 Generated with Claude Code

EricAndrechek and others added 7 commits October 21, 2026 13:28
@EricAndrechek @claude
docs(release): prepare the 0.2.1 changelog and upgrade guide
d78a788 
Unreleased becomes 0.2.1, with an upgrade summary on top, and Upgrading
gains "From 0.2.0 to 0.2.1": a binary swap whose four possible actions
are listing tracing proxies in server.trusted_proxies, choosing the
container or go install on a non-Linux host, replacing an endpoint
certificate that chains through an intermediate Go 1.26.10 distrusts,
and filtering the SSE drop metric on reason="buffer_full". The SDK stays
at 0.2.0: only its dev dependencies changed.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@EricAndrechek @claude
docs(release): file the post-0.2.0 entries under 0.2.1, and add the O…
a4c61c4 
…Tel upgrade step

Review follow-up. The importable settings model (#839) and the telemetry
process identity (#820) were filed under 0.2.0 after it was cut; they
ship in 0.2.1, so the 0.2.0 section is again what v0.2.0 tagged. The
upgrade guide gains the step #820 needs (OTEL_SERVICE_NAME and
OTEL_RESOURCE_ATTRIBUTES now apply; service.instance.id is fresh per
boot unless instance_id is set), the proxy step covers client.address
as well as traceparent, the /health and /ready aliases are "still served
in 0.2.1", and the settings page says pkg/ is public from v0.2.1.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@EricAndrechek @claude
docs(release): correct the OTel comparison and add the OTLP log-level…
b6a80cf 
… step

Review follow-up. 0.2.0 merged OTEL_RESOURCE_ATTRIBUTES too and pinned
only service.name to wavehouse; what changes in 0.2.1 is that
service.name from the environment wins and service.instance.id is new,
so the upgrade step, the summary and #820's entry say that. A sixth
step covers #850: OTLP log export now honors WH_LOG_LEVEL, so a log
backend stops receiving DEBUG records at the default level. The CA is
no longer named, since no cited source names it, and the page points at
Go's distrustedSPKIHashes instead; moving to a pk+sk dedupe table rules
out rolling back to 0.2.0.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@EricAndrechek @claude
docs(release): say what listing a proxy trusts, and how to check a ce…
5a832f5 
…rtificate

Review follow-up. A listed proxy's X-Forwarded-For and traceparent are
believed, so the proxy step says to have it append to the former and
drop the client's trace headers, or the trace injection #855 closed
comes back. The certificate step names the error a distrusted chain
gives and the openssl commands that compute the SPKI hash Go checks.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@EricAndrechek @claude
docs(release): the NATS certificate check, rolling back, and what log…
a5da7d9 
…s gain

Review follow-up. openssl s_client cannot read a NATS listener without
handshake_first, so the certificate check says to hash its cert_file
instead; rolling back to 0.2.0 needs the four new boot keys and
variables removed first, since 0.2.0 refuses unknown ones; and the logs
step says records now carry client.address and that every SSE stream
logs its opening and closing at INFO.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@EricAndrechek @claude
docs(release): hash every certificate in the chain, and other upgrade…
a972e49 
… details

Review follow-up. openssl x509 reads only a file's first certificate,
the endpoint's own, so the check now splits the chain and hashes each
certificate (tested against a public endpoint: three files, three
hashes). The proxy key is set in the same change that deploys 0.2.1, a
slow SSE consumer's lines are WARN, and on the Go 1.27 line only 1.27.3
or later carries the certificate fix.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@EricAndrechek @claude
docs(release): shorten the certificate step
b01770c 
The openssl recipe was more than a patch note needs; the step keeps the
error a distrusted chain gives and the link to Go's list.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Oct 21, 2026 •
edited
Loading

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration
  • Configuration used: Organization UI
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: f126a08b-6d83-4e7b-856c-d502b4dce0a5

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions github-actions Bot added documentation Improvements or additions to documentation area/docs Documentation, site/, README labels Oct 21, 2026
@github-actions

github-actions Bot commented Oct 21, 2026 •
edited
Loading

Copy link
Copy Markdown

📚 Docs preview

✅ Live: https://pr-877-wavehouse-docs.wave-rf.workers.dev (follows this PR)
This commit (b01770c): https://8d2a987e-wavehouse-docs.wave-rf.workers.dev (exactly this commit; open it if the link above looks stale)

  • Commit: b01770c docs(release): shorten the certificate step
  • Author: @EricAndrechek, Claude Opus 5.5
  • Committed: 2026-10-21 14:43 EDT
  • Uploaded: 2026-10-21 14:58 EDT (run)

@EricAndrechek
EricAndrechek marked this pull request as ready for review October 21, 2026 18:55
@EricAndrechek
EricAndrechek requested review from a team and taitelee October 21, 2026 18:55
@github-project-automation github-project-automation Bot moved this from Backlog to In progress in WaveHouse Task Board Oct 21, 2026
@EricAndrechek
EricAndrechek added this pull request to the merge queue Oct 21, 2026
@github-merge-queue
github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Oct 21, 2026
@EricAndrechek EricAndrechek mentioned this pull request Oct 21, 2026
Open
@EricAndrechek
EricAndrechek added this pull request to the merge queue Oct 21, 2026
Merged via the queue into main with commit abd2b46 Oct 21, 2026
@EricAndrechek
EricAndrechek deleted the docs/release-0.2.1 branch October 21, 2026 19:15
@github-project-automation github-project-automation Bot moved this from In progress to Done in WaveHouse Task Board Oct 21, 2026
@EricAndrechek EricAndrechek mentioned this pull request Oct 22, 2026
Draft
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@taitelee taitelee taitelee approved these changes

Assignees

No one assigned

Labels

area/docs Documentation, site/, README documentation Improvements or additions to documentation

Projects

WaveHouse Task Board
Archived in project

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@EricAndrechek @taitelee