Skip to content

[chore] Document 1Password CLI secret management in AGENTS.md (HAR-252)#231

Open
harryden wants to merge 1 commit into
mainfrom
chore/agents-secrets-1password
Open

[chore] Document 1Password CLI secret management in AGENTS.md (HAR-252)#231
harryden wants to merge 1 commit into
mainfrom
chore/agents-secrets-1password

Conversation

@harryden
Copy link
Copy Markdown
Owner

Summary

Document that secrets are managed via the 1Password CLI and that the canonical reference format is op:// (as already used in .env.example). Linear: HAR-252.

The existing ## Secrets policy section in AGENTS.md already covered the five baseline rules (no reading .env*, no real creds in code/PRs, OAuth server-side, mocked OAuth in tests, .env.example for variable names only). The only gap was the 1Password workflow, which agents previously had to infer from .env.example.

Changes

  • AGENTS.md: append one bullet to the existing ## Secrets policy section pointing agents to 1Password CLI and the op:// reference format. No other lines touched, no section duplication.

Tests

Docs-only change, but ran the full pre-PR suite locally on chore/agents-secrets-1password:

  • npm run lint — pass
  • npm run typecheck — pass
  • npm run test:run — 25 files, 160 tests, all pass
  • npm run build — built in 5.25s

Notes

  • No dependency on any other open PR.
  • Considered rewriting the whole section to match the source wording verbatim, but rejected — the existing bullets are already slightly more precise (e.g. the (except .env.example) parenthetical), so an append is the minimal correct change.

Copilot AI review requested due to automatic review settings May 27, 2026 19:12
@vercel
Copy link
Copy Markdown

vercel Bot commented May 27, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
linked-list Ready Ready Preview, Comment May 27, 2026 7:32pm

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 27, 2026

Warning

Review limit reached

@harryden, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 31 minutes and 51 seconds. Learn how PR review limits work.

Your organization has run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 4ce5f547-6bf3-4aeb-bf89-01b723d80549

📥 Commits

Reviewing files that changed from the base of the PR and between e75f72b and 3032239.

📒 Files selected for processing (1)
  • AGENTS.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/agents-secrets-1password

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 and usage tips.

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates agent-facing documentation for secret handling by adding 1Password CLI guidance to the existing secrets policy in AGENTS.md.

Changes:

  • Adds a secrets policy bullet describing 1Password CLI usage.
  • Documents op:// as the intended secret reference format.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread AGENTS.md Outdated
- Never add real credentials to code, tests, logs, commits, or PR descriptions
- OAuth client secrets must remain server-side only
- Use mocked OAuth responses in tests unless explicitly instructed otherwise
- Secrets are managed via 1Password CLI. Real values are never stored in plaintext files. If you need to reference a secret, use the `op://` reference format from `.env.example`.
Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

.env.example intentionally uses human-readable placeholder values (e.g. your-supabase-access-token) and is not the right place to demonstrate op:// reference format — that would mix the template's purpose (showing variable names) with runtime concerns. The bullet has been corrected to point at .env.local instead (where op run actually resolves secrets at runtime via scripts/dev-local.sh), so .env.example stays a clean human-readable template. See updated commit 3032239 on this branch.

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.

2 participants