Skip to content

DOC-7163 Update StackExchange.Redis SCH docs for auto-enablement (3.4.0) - #4225

Open
andy-stark-redis wants to merge 2 commits into
mainfrom
DOC-7163-dotnet-sch-auto-enable
Open

andy-stark-redis wants to merge 2 commits into
mainfrom
DOC-7163-dotnet-sch-auto-enable

Conversation

@andy-stark-redis

@andy-stark-redis andy-stark-redis commented Oct 8, 2026 •

Copy link
Copy Markdown
Contributor

Updates the StackExchange.Redis Smart client handoffs (SCH) docs for StackExchange/StackExchange.Redis#3248. That PR turns SCH on automatically for recognized Redis Cloud and Azure Managed Redis hostnames and for defaults=enterprise/rediscloud/amr, and retires the SER010 [Experimental] diagnostic. #3248 shipped in StackExchange.Redis 3.4.0 (2026-10-09), so the version note now says v3.4.0.

  • content/develop/clients/dotnet/connect.md: rewrites the SCH version note (3.3.0/3.3.1 stay opt-in with SER010; v3.4.0 drops it), replaces "SCH is disabled by default" with when auto-enablement applies and when it doesn't (Redis Software, CNAME/private DNS/proxy), removes the obsolete Defaults callout, and updates the MaintenanceNotifications default in the parameter table.
  • content/develop/clients/sch.md: removes the "StackExchange.Redis is marked [Experimental]" callout (and the spacer that only separated it from the failover callout).

🤖 Generated with Claude Code

@andy-stark-redis andy-stark-redis added do not merge yet parked PR speculatively added based on pre-release info. Check validity when release goes ahead. labels Oct 8, 2026
@github-actions

github-actions Bot commented Oct 8, 2026 •

Copy link
Copy Markdown
Contributor

DOC-7163

@github-actions

github-actions Bot commented Oct 8, 2026 •

Copy link
Copy Markdown
Contributor

🧠 Redis Memory

Found 6 related items from repository history (1 new this commit):

Memory updated at a134122

@github-actions

github-actions Bot commented Oct 8, 2026

Copy link
Copy Markdown
Contributor

@andy-stark-redis andy-stark-redis self-assigned this Oct 8, 2026
andy-stark-redis and others added 2 commits October 12, 2026 09:39
Rewrites the SCH section of dotnet/connect.md for StackExchange.Redis PR #3248
(merged to main 2026-10-07, merge 0fd86a1, not in 3.3.1): the Redis Cloud and
Azure Managed Redis hostname providers and the defaults=enterprise/rediscloud/amr
profiles now select MaintenanceNotifications=Auto, and the SER010
[Experimental] diagnostic is retired. Also drops the matching [Experimental]
callout from sch.md (and the spacer that only separated it from the callout
before it).

The PR description is internally inconsistent: it says the SER010 annotation is
removed but also that PublicAPI.Unshipped.txt "regains the three [SER010]override
entries". The merged diff settles it: every [Experimental] attribute and every
[SER010] PublicAPI entry is deleted, Directory.Build.props lists SER010 as
retired, and docs/exp/SER010.md is rewritten as "SER010 retired". The library
default is still Disabled; only provider recognition turns it on, so a Redis
Software database (no hostname pattern) or a hosted one behind a CNAME/private
DNS/proxy stays off unless defaults= or maintNotifications is set.

The release version is unknown at park time, so the draft says "vNEXT" with a
TODO(unpark) comment. The 3.3.0/3.3.1 behaviour is kept in the version note
because readers on those releases still need to know SCH is opt-in there.

Learned: SE.Redis #3248's PR body contradicts its merged diff on SER010; trust the diff
Constraint: v3.3.0/v3.3.1 remain opt-in with SER010; keep that in the version note
Directive: replace every vNEXT and delete the TODO(unpark) comment at unpark
Gaps: geo-failover groups suppress SCH even when auto-enabled; covered only by the existing sch.md failover note
Recheck: when the first StackExchange.Redis tag containing 0fd86a1 is published
Ticket: DOC-7163
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
….4.0

Fill the vNEXT placeholder with v3.4.0 and drop the TODO(unpark) comment.

Predicted vs actual: the park snapshot held completely. 3.4.0 (stable,
2026-10-09) contains merge 0fd86a1 (compare behind_by 0). The 7 commits
between the merge and the tag touch nothing in auto-enlistment: provider
overrides still select Auto, the hostname list in ServerMaintenanceEvent.md
and the RedisCloud/AMR IsMatch domains are unchanged, the library default
stays Disabled, and docs/exp/SER010.md reads "SER010 retired". The only
maintenance-adjacent change is test assertions relaxed for the new
dedicated RESP3 pub/sub connection (#3264), which has no doc impact here.

Checklist decisions: sch.md's client table stays v3.3.0 (support itself
dates from 3.3.0). The ConnectGroupAsync suppression gap stays covered by
sch.md's existing failover note only; no sentence added to connect.md,
since auto-enable doesn't change what the note says.

Learned: the scan digest reported 3.4.0 on 10 Oct but never tied it to the
parked trigger; the release check has to come from the manifest, not the digest.
Recheck: none
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@andy-stark-redis
andy-stark-redis force-pushed the DOC-7163-dotnet-sch-auto-enable branch from c3692ed to a134122 Compare October 12, 2026 08:39
@andy-stark-redis andy-stark-redis changed the title DOC-7163 Update StackExchange.Redis SCH docs for auto-enablement [PARKED] DOC-7163 Update StackExchange.Redis SCH docs for auto-enablement (3.4.0) Oct 12, 2026
@andy-stark-redis andy-stark-redis removed do not merge yet parked PR speculatively added based on pre-release info. Check validity when release goes ahead. labels Oct 12, 2026
@andy-stark-redis
andy-stark-redis requested a review from a team October 12, 2026 09:08
@andy-stark-redis andy-stark-redis added the clients Client library docs label Oct 12, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

clients Client library docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant