Skip to content

docs: clarify build and dependency install prerequisites for frameworks #462

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

Closed
reginaldalfret wants to merge 1 commit into from
Closed

docs: clarify build and dependency install prerequisites for frameworks #462

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
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,17 @@ jobs:
apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
```

> **Note:** If your application requires a compilation step or custom build output (such as Remix, Next.js / OpenNext, Astro, TanStack Start, SvelteKit, etc.), make sure to run your package manager install and build steps prior to `wrangler-action`:
> ```yaml
> - uses: actions/checkout@v6
> - run: npm ci
> - run: npm run build
> - name: Deploy
> uses: cloudflare/wrangler-action@v4
> with:
> apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
> ```

## Authentication

You'll need to configure Wrangler using GitHub's Secrets feature - go to "Settings -> Secrets" and add your Cloudflare API token (for help finding this, see the [Workers documentation](https://developers.cloudflare.com/workers/wrangler/ci-cd/#api-token)). Your API token is encrypted by GitHub, and the action won't print it into logs, so it should be safe!
Expand Down