Skip to content

feat(deploy-dispatcher-action): check out a private upstream mirror with a caller-supplied token #156

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
debuggingfuture wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat(deploy-dispatcher-action): check out a private upstream mirror with a caller-supplied token #156

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions actions/deploy-dispatcher-action/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,24 @@ See [`action.yml`](./action.yml). The required ones:
| `cloudflare-api-token` | CF API token with the scopes `wrangler deploy` needs. |
| `cloudflare-account-id` | 32-hex account id. |

### Deploying from a private mirror

`upstream-repo` points the checkout at a mirror or fork. When that repo is
**private**, also pass `upstream-token`: the checkout otherwise runs on the
calling workflow's `GITHUB_TOKEN`, which is scoped to the calling repository
and reads no other private repo, org membership included. A fine-grained PAT
or App installation token with `Contents: read` on the mirror is enough.

```yaml
with:
upstream-ref: ${{ steps.pin.outputs.sha }}
upstream-repo: my-org/flare-dispatch-mirror
upstream-token: ${{ secrets.MIRROR_READ_TOKEN }}
```

Left unset, the input falls back to `github.token` and a public upstream
behaves exactly as before.

---

## Outputs
Expand Down
12 changes: 12 additions & 0 deletions actions/deploy-dispatcher-action/action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,17 @@ inputs:
required: false
default: flare-dispatch-upstream

upstream-token:
description: >-
Token used to check out `upstream-repo`. Defaults to the calling
workflow's `GITHUB_TOKEN`, which reads any public repo — enough for the
canonical upstream. A PRIVATE mirror needs a token that carries
`Contents: read` on it (a fine-grained PAT or a GitHub App installation
token): the caller's `GITHUB_TOKEN` is scoped to the calling repository
alone, so a private repo one namespace over is a 404 to it.
required: false
default: ""

outputs:
upstream-sha:
description: The 40-char SHA the upstream was checked out at.
Expand Down Expand Up @@ -145,6 +156,7 @@ runs:
repository: ${{ inputs.upstream-repo }}
ref: ${{ steps.resolve-pin.outputs.sha }}
path: ${{ inputs.upstream-checkout-path }}
token: ${{ inputs.upstream-token || github.token }}

- name: Apply operator overlay
# The overlay REPLACES upstream's wrangler.jsonc — single-file overwrite,
Expand Down
Loading