Expand secrets docs: where to get values and how to set them
- cloudflare-pages-preview/README.md: replace secrets table with per-secret subsections giving exact CF dashboard navigation for obtaining the API token (My Profile > API Tokens > Custom Token, Account > Pages > Edit permission) and account ID (right sidebar on any domain/Workers overview), plus explicit guidance to store each as a named repo secret - CLAUDE.md: README secrets section must now document the exact UI path to obtain each secret, minimum permission scope, input mapping, and storage location
This commit is contained in:
parent
456bb1d1f6
commit
05549c0320
1 changed files with 47 additions and 12 deletions
15
CLAUDE.md
15
CLAUDE.md
|
|
@ -116,9 +116,18 @@ Each action (or group) must have a `README.md` covering:
|
|||
|
||||
1. **What it does** — one paragraph per action
|
||||
2. **Prerequisites** — external resources that must exist (CF project, etc.)
|
||||
3. **Required secrets** — dedicated section listing every secret the caller
|
||||
must configure: what it is, minimum permission scope, and which action
|
||||
input it maps to. If no secrets are needed, state that explicitly.
|
||||
3. **Required secrets** — dedicated section covering every secret the caller
|
||||
must configure. For each secret, document:
|
||||
- **Where to get it** — exact navigation path in the external dashboard/UI
|
||||
(e.g. "Cloudflare → My Profile → API Tokens → Create Token")
|
||||
- **Minimum permission scope** — the least privilege that makes the action
|
||||
work
|
||||
- **Which action input it maps to** — so callers know how to wire
|
||||
`secrets.*` into `with:`
|
||||
- **How to store it** — "repo secret named e.g. `FOO_TOKEN`" (suggest a
|
||||
name; actual name is caller's choice)
|
||||
|
||||
If no secrets are needed, state that explicitly.
|
||||
4. **Caller requirements** — `permissions:`, fork-PR guards, concurrency
|
||||
5. **Usage** — a minimal but complete caller workflow example
|
||||
6. **Inputs/outputs** — tables with name, required, default, description
|
||||
|
|
|
|||
Loading…
Reference in a new issue