Skip to content

docs(agents): correct the auth-strategy config key (config.authStrategy)#656

Merged
coderdan merged 1 commit into
mainfrom
docs/agents-md-authstrategy-key
Jul 15, 2026
Merged

docs(agents): correct the auth-strategy config key (config.authStrategy)#656
coderdan merged 1 commit into
mainfrom
docs/agents-md-authstrategy-key

Conversation

@coderdan

@coderdan coderdan commented Jul 15, 2026

Copy link
Copy Markdown
Contributor

One-line fix: AGENTS.md's identity-aware-encryption bullet named the config key config.strategy; the real ClientConfig key is authStrategy (packages/stack/src/types.ts:145, and the re-export comment in packages/stack/src/index.ts says the same).

Caught while re-reviewing #642 — its examples use the correct key; the drift was in the meta file. No changeset: AGENTS.md is repo-internal (not shipped in any tarball).

https://claude.ai/code/session_01MxTTPaPP16m6br7Hoab94w

Summary by CodeRabbit

  • Documentation
    • Updated identity-aware encryption guidance to use the correct config.authStrategy setting when authenticating with OIDC federation.
    • Clarified the existing chaining and lock-context requirements.

AGENTS.md said the strategy is passed as `config.strategy`; the real
ClientConfig key is `authStrategy` (packages/stack/src/types.ts). Caught while
re-reviewing #642, whose examples use the correct key — the drift was here,
not there. Rule 7 says keep the meta files honest; one wrong key name in the
file every agent reads is exactly how a wrong example propagates.

Claude-Session: https://claude.ai/code/session_01MxTTPaPP16m6br7Hoab94w
@coderdan
coderdan requested a review from a team as a code owner July 15, 2026 15:15
@changeset-bot

changeset-bot Bot commented Jul 15, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 7744caf

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai

coderabbitai Bot commented Jul 15, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: b0e85d0b-de94-4542-9263-311bdc4087e8

📥 Commits

Reviewing files that changed from the base of the PR and between 9bf2a56 and 7744caf.

📒 Files selected for processing (1)
  • AGENTS.md

📝 Walkthrough

Walkthrough

The identity-aware encryption documentation now references config.authStrategy when configuring OidcFederationStrategy; chaining and lock-context requirements remain unchanged.

Changes

Identity-aware encryption documentation

Layer / File(s) Summary
Authentication configuration reference
AGENTS.md
Updates the OidcFederationStrategy authentication reference from config.strategy to config.authStrategy.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Suggested reviewers: calvinbrewer

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the doc-only fix to the auth strategy config key in AGENTS.md.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/agents-md-authstrategy-key

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.

@coderdan
coderdan merged commit a6b8a0e into main Jul 15, 2026
10 checks passed
@coderdan
coderdan deleted the docs/agents-md-authstrategy-key branch July 15, 2026 18:10
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