Move mikenomitch/hello-world-containers to templates/containers-template #716

th0m · 2025-06-20T23:57:57Z

Description

Fixes #CC-5506.

Checklist

Template Metadata
- template directory ends with -template
- "cloudflare" section of package.json is populated
- template preview image uploaded to Images
- README is populated and uses  and  to designate the Dash readme preview
- package.json contains a deploy command

Example package.json

"cloudflare": {
  "label": "Worker + D1 Database",
  "products": [
    "Workers",
    "D1"
  ],
  "categories": [
    "storage"
  ],
  "docs_url": "https://developers.cloudflare.com/d1/",
  "preview_image_url": "https://imagedelivery.net/wSMYJvS3Xw-n339CbDyDIA/cb7cb0a9-6102-4822-633c-b76b7bb25900/public"
}

github-actions · 2025-06-21T00:19:09Z

template	name	version	latestVersion	isDevDependency
containers-template	@cloudflare/containers	^0.0.8	0.0.8	false
containers-template	@cloudflare/workers-types	^4.20250506.0	4.20250620.0	true
containers-template	typescript	^5.5.2	5.8.3	true
containers-template	wrangler	https://pkg.pr.new/wrangler@9098	4.20.5	true

github-actions · 2025-06-21T00:19:12Z

Preview link not generated: you must be on a branch, not on a fork.
Collaborators may enable previews for this pull request by attaching the allow preview label.
If you are already a collaborator, please create a branch rather than forking.

th0m · 2025-06-21T15:24:37Z

@shaunpersad @deloreyj @cmsparks can one of you please take a look?
Thank you

mikenomitch · 2025-06-21T16:42:28Z

@th0m do you need preview images in the package.json?

mikenomitch · 2025-06-21T16:43:40Z

containers-template/src/index.ts

+  defaultPort = 8080;
+  sleepAfter = "2m";
+  envVars = {
+    MESSAGE: "I was passed in via the container class!",


super nit - the way this is interpolated the "!" results in a grammar error

Maybe wrap this in internal quotes?

Sounds good, this is how it prints now:
Hi, I'm a container and this is my message: "I was passed in via the container class!", my instance ID is: d037394b-e266-4e55-8b7c-dbd2cb99354d

th0m · 2025-06-21T21:25:52Z

@th0m do you need preview images in the package.json?

Yep I submitted this to get early feedback, working on the images now

github-actions · 2025-06-21T21:47:58Z

Preview link not generated: you must be on a branch, not on a fork.
Collaborators may enable previews for this pull request by attaching the allow preview label.
If you are already a collaborator, please create a branch rather than forking.

github-actions · 2025-06-21T21:50:49Z

Preview link not generated: you must be on a branch, not on a fork.
Collaborators may enable previews for this pull request by attaching the allow preview label.
If you are already a collaborator, please create a branch rather than forking.

github-actions · 2025-06-21T22:05:27Z

Preview link not generated: you must be on a branch, not on a fork.
Collaborators may enable previews for this pull request by attaching the allow preview label.
If you are already a collaborator, please create a branch rather than forking.

jahands · 2025-06-23T16:01:42Z

containers-template/tsconfig.json

+    /* Specify how TypeScript looks up a file from a given module specifier. */
+    "moduleResolution": "Bundler",
+    /* Specify type package names to be included without being referenced in a source file. */
+    "types": ["@cloudflare/workers-types/2023-07-01"],


We shouldn't use @cloudflare/workers-types when using worker-configuration.d.ts

This should be ./worker-configuration.d.ts and @cloudflare/workers-types should be removed from package.json dependencies

jahands · 2025-06-23T16:07:20Z

containers-template/src/index.ts

+import { Container, loadBalance, getContainer } from "@cloudflare/containers";
+
+export class MyContainer extends Container {
+  defaultPort = 8080;


might consider adding comments to these options for users who are less familiar with these (and don't read the docs)

jahands · 2025-06-23T16:07:50Z

containers-template/src/index.ts

+    MESSAGE: "I was passed in via the container class!",
+  };
+
+  override onStart() {


may be worth adding a comment above these explaining that these are optional

jahands · 2025-06-23T16:27:38Z

containers-template/src/index.ts

+
+    // To route requests to a specific container,
+    // pass a unique container identifier to .get()
+    if (pathname.startsWith("/container")) {


I would consider converting this routing logic to a Hono router. I know this is a hello-world example, but a router is needed to build anything meaningful. New users who use this may not know a router exists and end up going way too far with this style of routing and feeling like Workers is difficult to use.

Defaults make a big difference in user experience

+1 to this. The initial simplicity of path-based routing quickly turns into a stumbling block for new users. We are in the process of adding Hono as a requirement to the Contributor Guidelines.

github-actions · 2025-06-23T18:34:55Z

template	name	version	latestVersion	isDevDependency
containers-template	@cloudflare/containers	^0.0.8	0.0.10	false
containers-template	@cloudflare/workers-types	^4.20250506.0	4.20250620.0	true
containers-template	typescript	^5.5.2	5.8.3	true
containers-template	wrangler	https://pkg.pr.new/wrangler@9098	4.20.5	true

github-actions · 2025-06-23T18:35:19Z

Dashboard preview link

- Replace @cloudflare/workers-types with ./worker-configuration.d.ts in tsconfig.json - Remove @cloudflare/workers-types from package.json dependencies - Add Hono for better routing and developer experience - Add helpful comments for container configuration options - Convert manual pathname parsing to clean Hono route handlers

deloreyj · 2025-06-23T18:28:26Z

containers-template/package.json

+  "devDependencies": {
+    "@cloudflare/workers-types": "^4.20250506.0",
+    "typescript": "^5.5.2",
+    "wrangler": "https://pkg.pr.new/wrangler@9098"


When will we be able to update this to an actual wrangler version?

Later today, wrangler team cutting a release right now

th0m · 2025-06-23T19:10:47Z

I believe I have addressed your comments, ready for review.

github-actions · 2025-06-23T19:11:15Z

template	name	version	latestVersion	isDevDependency
containers-template	@cloudflare/containers	^0.0.10	0.0.10	false
containers-template	hono	^4.8.2	4.8.2	false
containers-template	typescript	^5.5.2	5.8.3	true
containers-template	wrangler	https://pkg.pr.new/wrangler@main	4.20.5	true

github-actions · 2025-06-23T19:11:24Z

Dashboard preview link

github-actions · 2025-06-23T20:44:49Z

template	name	version	latestVersion	isDevDependency
containers-template	@cloudflare/containers	^0.0.10	0.0.10	false
containers-template	hono	^4.8.2	4.8.2	false
containers-template	typescript	^5.5.2	5.8.3	true
containers-template	wrangler	^4.21.0	4.21.0	true

github-actions · 2025-06-23T20:45:07Z

Dashboard preview link

th0m force-pushed the tlefebvre/CC-5506 branch 3 times, most recently from 6362bb8 to 4b2be6e Compare June 21, 2025 00:16

gpanders approved these changes Jun 21, 2025

View reviewed changes

mikenomitch reviewed Jun 21, 2025

View reviewed changes

skepticfx approved these changes Jun 21, 2025

View reviewed changes

th0m force-pushed the tlefebvre/CC-5506 branch from 4b2be6e to a4bc6f8 Compare June 21, 2025 21:45

th0m force-pushed the tlefebvre/CC-5506 branch 2 times, most recently from 688f5a5 to e5ba5dc Compare June 21, 2025 21:50

th0m force-pushed the tlefebvre/CC-5506 branch from e5ba5dc to 261e2d5 Compare June 21, 2025 21:52

Move mikenomitch/hello-world-containers to templates/containers-template

63f5cbd

th0m force-pushed the tlefebvre/CC-5506 branch from 261e2d5 to 63f5cbd Compare June 21, 2025 22:02

jahands reviewed Jun 23, 2025

View reviewed changes

deloreyj added the allow preview allows for preview links on forks label Jun 23, 2025

deloreyj reviewed Jun 23, 2025

View reviewed changes

Update Hono to latest version (4.8.2)

b189737

Regenerate pnpm-lock.yaml after dependency updates

aba50d3

jahands approved these changes Jun 23, 2025

View reviewed changes

Pin wrangler to 4.21.0 for containers-template

c08bc71

th0m force-pushed the tlefebvre/CC-5506 branch from e82df14 to c08bc71 Compare June 23, 2025 20:42

deloreyj approved these changes Jun 23, 2025

View reviewed changes

deloreyj merged commit 9635cab into cloudflare:main Jun 23, 2025
2 checks passed

Move mikenomitch/hello-world-containers to templates/containers-template #716

Move mikenomitch/hello-world-containers to templates/containers-template #716

Conversation

th0m commented Jun 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Example package.json

Uh oh!

github-actions bot commented Jun 21, 2025

Uh oh!

github-actions bot commented Jun 21, 2025

Uh oh!

th0m commented Jun 21, 2025

Uh oh!

mikenomitch commented Jun 21, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

th0m commented Jun 21, 2025

Uh oh!

github-actions bot commented Jun 21, 2025

Uh oh!

github-actions bot commented Jun 21, 2025

Uh oh!

github-actions bot commented Jun 21, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Jun 23, 2025

Uh oh!

github-actions bot commented Jun 23, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

th0m commented Jun 23, 2025

Uh oh!

github-actions bot commented Jun 23, 2025

Uh oh!

github-actions bot commented Jun 23, 2025

Uh oh!

github-actions bot commented Jun 23, 2025

Uh oh!

github-actions bot commented Jun 23, 2025

Uh oh!

Uh oh!

Uh oh!

th0m commented Jun 20, 2025 •

edited

Loading