Skip to content

Commit 590e9e2

Browse files
committed
Update README.md
1 parent 8f880e6 commit 590e9e2

1 file changed

Lines changed: 23 additions & 37 deletions

File tree

README.md

Lines changed: 23 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -8,35 +8,21 @@ This Action:
88
- Lets you define custom deployment messages (and an optional tag string) using templates.
99
- Exposes the Worker Version ID and deployment URL as outputs for downstream steps.
1010
- Is designed for workflows where you build in GitHub Actions and want clean, traceable deploys in Cloudflare.
11-
12-
## When to use this instead of the official Cloudflare Action
1311

14-
Use this Action when:
15-
16-
- You want full control over how and where your Worker is built:
17-
- You build in GitHub Actions (pnpm, npm, turbo, etc.) and only need Wrangler for the final upload/deploy.
18-
- You want rich, commit-aware metadata in Cloudflare:
19-
- You care about seeing branch, commit, actor, and custom messages in the Cloudflare Versions UI.
20-
- You want stable `version_id` outputs to link deploys back to code, PRs, or changelogs.
21-
- You’re in a monorepo:
22-
- You only want to build and deploy when a specific app/package directory changes.
23-
- You want an Action that targets a specific `config` path and doesn’t assume a single-project repo.
24-
- You prefer an explicit upload → deploy flow:
25-
- You want `wrangler versions upload` + `wrangler versions deploy <versionId>` semantics instead of a generic `wrangler deploy`.
26-
- You want your cloudflare deployment dashboard to look like this:
27-
<img width="2168" height="886" alt="Zen-2025-11-10 at 21 04 46@2x" src="https://github.com/user-attachments/assets/27c329b9-dc68-438d-ba6e-a264bac14390" />
12+
## When to use this instead of the official Cloudflare Action
2813

14+
### Use this Action if you need:
2915

30-
The official Cloudflare Actions are great if:
16+
- Monorepo-friendly behavior. Selective path based deployments.
17+
- Custom build pipelines. Build on GitHub actions.
18+
- Strong, composable metadata around each version and deployment:
3119

32-
- You want a quick, simple deploy with minimal control.
33-
- You’re okay with less flexibility around build steps, metadata, and monorepo layouts.
20+
<img width="2168" height="886" alt="Zen-2025-11-10 at 21 04 46@2x" src="https://github.com/user-attachments/assets/27c329b9-dc68-438d-ba6e-a264bac14390" />
3421

35-
Use this Action if you need:
22+
### The official Cloudflare Actions are great if:
3623

37-
- Monorepo-friendly behavior.
38-
- Custom build pipelines.
39-
- Strong, composable metadata around each deployment.
24+
- You want a quick, simple deploy with minimal control.
25+
- You’re okay with less flexibility around build steps and monorepo layouts.
4026

4127
## Features
4228

@@ -265,7 +251,7 @@ jobs:
265251

266252
- name: Upload + deploy via Wrangler Versions with metadata
267253
id: cf_deploy
268-
uses: your-org/wrangler-version-deploy-action-with-metadata@v1
254+
uses: mkcode/wrangler-version-deploy-action-with-metadata
269255
with:
270256
api_token: ${{ secrets.CLOUDFLARE_API_TOKEN }}
271257
wrangler_command: "pnpm dlx wrangler@4"
@@ -305,7 +291,7 @@ jobs:
305291
306292
- name: Upload Worker Version with metadata (no deploy)
307293
id: cf_upload
308-
uses: your-org/wrangler-version-deploy-action-with-metadata@v1
294+
uses: mkcode/wrangler-version-deploy-action-with-metadata
309295
with:
310296
api_token: ${{ secrets.CLOUDFLARE_API_TOKEN }}
311297
wrangler_command: "pnpm dlx wrangler@4"
@@ -327,7 +313,7 @@ You can combine outputs with other Actions to post deployment info back to PRs:
327313
```yaml
328314
- name: Deploy with metadata
329315
id: cf_deploy
330-
uses: your-org/wrangler-version-deploy-action-with-metadata@v1
316+
uses: mkcode/wrangler-version-deploy-action-with-metadata
331317
with:
332318
api_token: ${{ secrets.CLOUDFLARE_API_TOKEN }}
333319
config: "wrangler.toml"
@@ -394,14 +380,14 @@ jobs:
394380
# - run: pnpm install
395381
# - run: pnpm build
396382

397-
name: Upload + deploy worker-app via Versions API with metadata
398-
id: cf_deploy
399-
uses: your-org/wrangler-version-deploy-action-with-metadata@v1
400-
with:
401-
api_token: ${{ secrets.CLOUDFLARE_API_TOKEN }}
402-
wrangler_command: "pnpm dlx wrangler@4"
403-
working_directory: "apps/worker-app"
404-
config: "wrangler.toml"
405-
upload_args: "--env production"
406-
deploy_args: "--env production"
407-
message_template: "worker-app: {{repo}}@{{short_sha}} on {{branch}} (run {{run_number}})"
383+
- name: Upload + deploy worker-app via Versions API with metadata
384+
id: cf_deploy
385+
uses: mkcode/wrangler-version-deploy-action-with-metadata
386+
with:
387+
api_token: ${{ secrets.CLOUDFLARE_API_TOKEN }}
388+
wrangler_command: "pnpm dlx wrangler@4"
389+
working_directory: "apps/worker-app"
390+
config: "wrangler.toml"
391+
upload_args: "--env production"
392+
deploy_args: "--env production"
393+
message_template: "worker-app: {{repo}}@{{short_sha}} on {{branch}} (run {{run_number}})"

0 commit comments

Comments
 (0)