Skip to content
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.

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

Binding contrib guide #6864

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Binding contrib guide #6864

wants to merge 4 commits into from

Conversation

RamIdeas
Copy link
Contributor

@RamIdeas RamIdeas commented Sep 30, 2024

What this PR solves / how to test

Fixes DEVX-1368

Author has addressed the following

  • Tests
    • TODO (before merge)
    • Tests included
    • Tests not necessary because:
  • E2E Tests CI Job required? (Use "e2e" label or ask maintainer to run separately)
    • I don't know
    • Required
    • Not required because:
  • Changeset (Changeset guidelines)
    • TODO (before merge)
    • Changeset included
    • Changeset not necessary because:
  • Public documentation
    • TODO (before merge)
    • Cloudflare docs PR(s):
    • Documentation not necessary because:

Copy link

changeset-bot bot commented Sep 30, 2024

⚠️ No Changeset found

Latest commit: a02a88e

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

github-actions bot commented Sep 30, 2024

A wrangler prerelease is available for testing. You can install this latest build in your project with:

npm install --save-dev https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/11110946688/npm-package-wrangler-6864

You can reference the automatically updated head of this PR with:

npm install --save-dev https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/prs/6864/npm-package-wrangler-6864

Or you can use npx with this latest build directly:

npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/11110946688/npm-package-wrangler-6864 dev path/to/script.js
Additional artifacts:
npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/11110946688/npm-package-create-cloudflare-6864 --no-auto-update
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/11110946688/npm-package-cloudflare-kv-asset-handler-6864
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/11110946688/npm-package-miniflare-6864
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/11110946688/npm-package-cloudflare-pages-shared-6864
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/11110946688/npm-package-cloudflare-vitest-pool-workers-6864
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/11110946688/npm-package-cloudflare-workers-editor-shared-6864
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/11110946688/npm-package-cloudflare-workers-shared-6864

Note that these links will no longer work once the GitHub Actions artifact expires.


[email protected] includes the following runtime dependencies:

Package Constraint Resolved
miniflare workspace:* 3.20240925.0
workerd 1.20240925.0 1.20240925.0
workerd --version 1.20240925.0 2024-09-25

Please ensure constraints are pinned, and miniflare/workerd minor versions match.

Copy link
Contributor

@penalosa penalosa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should also include:

  • wrangler types
  • wrangler init --from-dash
  • SDW types

@RamIdeas
Copy link
Contributor Author

This should also include:

  • wrangler types
  • wrangler init --from-dash
  • SDW types

Addressed in a02a88e

@RamIdeas RamIdeas marked this pull request as ready for review October 7, 2024 10:34
@RamIdeas RamIdeas requested a review from a team as a code owner October 7, 2024 10:34
# How to register a binding

1. Register wrangler.toml section in: `packages/wrangler/src/config/environment.ts` [ref](https://github.com/cloudflare/workers-sdk/blob/ce7db9d9cb4f5bcd5a326b86dde051cb54b999fb/packages/wrangler/src/config/environment.ts#L431-L451)
1. Register validation functions in: `packages/wrangler/src/config/validation.ts` [ref-1](https://github.com/cloudflare/workers-sdk/blob/ce7db9d9cb4f5bcd5a326b86dde051cb54b999fb/packages/wrangler/src/config/validation.ts#L1297-L1306)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks fine in a markdown viewer (the numbers are corrected), but looks odd in the raw state.

Copy link
Contributor

@petebacondarwin petebacondarwin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! It's scary how spread out this stuff is.

Does one also need to update the resolveBindings() function in ConfigController.ts too?

Also, I feel like this should be in some kind of docs folder rather than the root of the wrangler package... e.g. packages/wrangler/docs/how-to/add-a-binging.md?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: In Review
Development

Successfully merging this pull request may close these issues.

4 participants