Update ADK skills from agent-lack master - #54
Conversation
Greptile SummaryThis PR updates eight ADK skill and command documentation files to align with the current
Confidence Score: 4/5Safe to merge — all changes are documentation and skill markdown files with no executable code paths affected. The changes are internally consistent and align secrets, CLI flags, and Dev Console descriptions across all eight files. Two small gaps stand out: the best-practice code example in skills/adk/references/agent-config.md (incomplete best-practice snippet) and skills/adk/references/files.md (unregistered MIME type for .mdx) Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[Declare secret in agent.config.ts] --> B[Dev: adk secret:set KEY value]
A --> C[Prod: adk secret:set KEY value --prod]
B --> D[Stored in .adk/secrets.json]
C --> E[Stored on remote bot - write-only]
D --> F[Read via secrets.KEY at runtime]
E --> F
F --> G[Bot code uses value]
subgraph adk-ship pre-deploy checks
H[adk secret --prod --format json] --> I{All required prod secrets set?}
I -- No --> J[Warn / show adk secret:set cmds]
I -- Yes --> K[adk deploy]
K --> L{--require-secrets flag?}
L -- Yes --> M[Hard fail if any unset]
L -- No --> N[Warn only, deploy proceeds]
end
%%{init: {'theme': 'base', 'themeVariables': {"darkMode": true, "background": "#0d1117", "primaryColor": "#21262d", "primaryTextColor": "#e6edf3", "primaryBorderColor": "#8b949e", "lineColor": "#8b949e", "textColor": "#e6edf3", "edgeLabelBackground": "#161b22", "actorBkg": "#21262d", "actorBorder": "#8b949e", "actorTextColor": "#e6edf3", "actorLineColor": "#8b949e", "signalColor": "#8b949e", "signalTextColor": "#e6edf3", "noteBkgColor": "#373320", "noteBorderColor": "#d4a72c", "noteTextColor": "#f0e6c0", "labelBoxBkgColor": "#21262d", "labelBoxBorderColor": "#8b949e", "labelTextColor": "#e6edf3", "loopTextColor": "#e6edf3", "activationBkgColor": "#30363d", "activationBorderColor": "#8b949e"}}}%%
flowchart TD
A[Declare secret in agent.config.ts] --> B[Dev: adk secret:set KEY value]
A --> C[Prod: adk secret:set KEY value --prod]
B --> D[Stored in .adk/secrets.json]
C --> E[Stored on remote bot - write-only]
D --> F[Read via secrets.KEY at runtime]
E --> F
F --> G[Bot code uses value]
subgraph adk-ship pre-deploy checks
H[adk secret --prod --format json] --> I{All required prod secrets set?}
I -- No --> J[Warn / show adk secret:set cmds]
I -- Yes --> K[adk deploy]
K --> L{--require-secrets flag?}
L -- Yes --> M[Hard fail if any unset]
L -- No --> N[Warn only, deploy proceeds]
end
|
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
| ## Best Practices | ||
|
|
||
| ### 1. Use Environment Variables for Secrets | ||
| ### 1. Use Declared Secrets for Runtime Credentials | ||
|
|
||
| ```typescript | ||
| // ❌ Bad - hardcoded secrets | ||
| config: { | ||
| apiKey: 'sk-abc123def456' | ||
| } | ||
|
|
||
| // ✅ Good - environment variable | ||
| config: { | ||
| apiKey: process.env.OPENAI_API_KEY | ||
| // ✅ Good - declared in agent.config.ts | ||
| secrets: { | ||
| OPENAI_API_KEY: { | ||
| description: 'OpenAI API key' | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| Use `${env:VAR_NAME}` only for integration or plugin configuration values that the CLI applies to Cloud. For credentials read by bot code, declare a secret and access it through `secrets.KEY`. |
There was a problem hiding this comment.
The "✅ Good" snippet shows only the declaration in agent.config.ts but not how it replaces the bad pattern at the call site. A reader who copied the old config: { apiKey: process.env.OPENAI_API_KEY } pattern still won't know what to write instead in the place where the key is consumed. Adding a second snippet (or extending the single one) that shows const apiKey = secrets.OPENAI_API_KEY would make the contrast self-contained without requiring the reader to scroll to the Secrets subsection above.
Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
* docs(adk): update skills from agent-lack master * docs(adk): address skill review comments * docs(adk): address greptile review notes
2 participants
Summary
agent-lackorigin/masteratef112a24.--require-secretsis available for CI-strict deploys./adk-shipand/adk-validateguidance to match current deploy and secret handling.Review follow-up
.adkignoreguidance because that agent-lack change is not merged yet.secrets.OPENAI_API_KEYaccess to the best-practice secret example..mdxMIME example totext/markdown; the source selector is extension-based and MDX is indexed as Markdown text.Validation
git diff --checkgit ls-files -z | xargs -0 bunx oxfmt@0.41.0 --check2f5bafb: Code Qualitycheck, commands manifestcheck, andvalidate.Note: full
bun run format:checkscans the existing untracked.claude/worktrees in this checkout, so validation used the tracked file set that matches the PR contents.