Skip to content

Commit 016df69

Browse files
committed
docs: use vars (not secrets) for model overrides; state the slug format rule
A model name is non-sensitive config, so steer overrides to a repo variable (vars.AGENT_MODEL) and keep secrets. for the key. State the format rule once: bare OpenRouter slug, exactly one '/', no 'openrouter/' prefix.
1 parent 1fe4e6a commit 016df69

1 file changed

Lines changed: 6 additions & 4 deletions

File tree

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -78,15 +78,17 @@ OPENROUTER_API_KEY = sk-or-...
7878

7979
That's the only required setup — it's passed via `llm_api_key` above. (For local runs with `scripts/run_local.sh`, export `OPENROUTER_API_KEY` as an env var instead.)
8080

81-
**Models are optional.** Omit `agent_model` / `parsing_model` to use the engine's default for your provider, or pin them to a **bare OpenRouter slug** (no `openrouter/` prefix) — inline or from a secret:
81+
**Models are optional.** Omit `agent_model` / `parsing_model` to use the engine's default for your provider, or pin them — inline or from a repository **variable** (a model name isn't a secret, so use `vars.`, not `secrets.`):
8282

8383
```yaml
8484
with:
85-
llm_api_key: ${{ secrets.OPENROUTER_API_KEY }}
86-
agent_model: anthropic/claude-sonnet-4 # optional; or ${{ secrets.AGENT_MODEL }}
87-
parsing_model: google/gemini-3-flash-preview # optional
85+
llm_api_key: ${{ secrets.OPENROUTER_API_KEY }} # secret
86+
agent_model: anthropic/claude-sonnet-4 # optional; or ${{ vars.AGENT_MODEL }}
87+
parsing_model: google/gemini-3-flash-preview # optional
8888
```
8989
90+
**Model format:** a bare OpenRouter slug (e.g. `anthropic/claude-sonnet-4`) — exactly one `/`, **no `openrouter/` prefix** (that's the LiteLLM form; the action rejects it early).
91+
9092
## When it runs
9193

9294
- **PR opened / reopened / marked ready** — generated once (per the `on:` triggers above). It does **not** re-run on every push, so you never spend an LLM job per commit; the comment reflects that point until refreshed.

0 commit comments

Comments
 (0)