Skip to content

Commit 8f880e6

Browse files
authored
Refactor README to remove redundant usage section
Removed redundant section on when to use the custom Action instead of the official Cloudflare Action.
1 parent c2d7b5a commit 8f880e6

1 file changed

Lines changed: 29 additions & 26 deletions

File tree

README.md

Lines changed: 29 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -8,32 +8,35 @@ 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
13-
+
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-
+
27-
+The official Cloudflare Actions are great if:
28-
+
29-
+- You want a quick, simple deploy with minimal control.
30-
+- You’re okay with less flexibility around build steps, metadata, and monorepo layouts.
31-
+
32-
+Use this Action if you need:
33-
+
34-
+- Monorepo-friendly behavior.
35-
+- Custom build pipelines.
36-
+- Strong, composable metadata around each deployment.
11+
12+
## When to use this instead of the official Cloudflare Action
13+
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" />
28+
29+
30+
The official Cloudflare Actions are great if:
31+
32+
- You want a quick, simple deploy with minimal control.
33+
- You’re okay with less flexibility around build steps, metadata, and monorepo layouts.
34+
35+
Use this Action if you need:
36+
37+
- Monorepo-friendly behavior.
38+
- Custom build pipelines.
39+
- Strong, composable metadata around each deployment.
3740

3841
## Features
3942

0 commit comments

Comments
 (0)