Simplify secrets table: just the action input name, not full YAML
The caller already knows how to wire secrets.X into with: inputs; the table only needs to name the input, not repeat the secret name in a YAML snippet.
This commit is contained in:
parent
2a230c7793
commit
48110cb715
2 changed files with 5 additions and 5 deletions
|
|
@ -121,9 +121,9 @@ Each action (or group) must have a `README.md` covering:
|
|||
copy-paste without deciding:
|
||||
|
||||
```markdown
|
||||
| Repo secret name | Passed as | Value |
|
||||
| Repo secret name | Action input | Value |
|
||||
|---|---|---|
|
||||
| `FOO_API_TOKEN` | `api-token: ${{ secrets.FOO_API_TOKEN }}` | ... |
|
||||
| `FOO_API_TOKEN` | `api-token` | ... |
|
||||
```
|
||||
|
||||
Follow the table with a subsection per secret documenting:
|
||||
|
|
|
|||
|
|
@ -28,10 +28,10 @@ and cleaning them up when the PR closes.
|
|||
Create these secrets in the caller repo: GitHub → repo → **Settings → Secrets
|
||||
and variables → Actions → New repository secret**.
|
||||
|
||||
| Repo secret name | Passed as | Value |
|
||||
| Repo secret name | Action input | Value |
|
||||
|---|---|---|
|
||||
| `CF_PAGES_PREVIEW_API_TOKEN` | `api-token: ${{ secrets.CF_PAGES_PREVIEW_API_TOKEN }}` | Cloudflare API token with `Account → Cloudflare Pages → Edit` permission, scoped to the single account that owns your Pages project |
|
||||
| `CF_PAGES_PREVIEW_ACCOUNT_ID` | `account-id: ${{ secrets.CF_PAGES_PREVIEW_ACCOUNT_ID }}` | Cloudflare account ID (hex string from the dashboard sidebar) |
|
||||
| `CF_PAGES_PREVIEW_API_TOKEN` | `api-token` | Cloudflare API token with `Account → Cloudflare Pages → Edit` permission, scoped to the single account that owns your Pages project |
|
||||
| `CF_PAGES_PREVIEW_ACCOUNT_ID` | `account-id` | Cloudflare account ID (hex string from the dashboard sidebar) |
|
||||
|
||||
Both `deploy` and `cleanup` need the same two secrets.
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue