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

add configuration section with local workerd linking to Miniflare readme #5921

Merged
merged 1 commit into from
May 30, 2024

Conversation

dario-piotrowicz
Copy link
Member

This PR is simply adding info about the MINIFLARE_WORKERD_PATH env variable in the main Miniflare readme
(each time I need to use the env variable I need to dig through the code for it etc... I figured it could be worth to properly document this?)

Author has addressed the following

  • Tests
    • TODO (before merge)
    • Included
    • Not necessary because: this is a simple md change
  • E2E Tests CI Job required? (Use "e2e" label or ask maintainer to run separately)
    • I don't know
    • Required / Maybe required
    • Not required because: this is a simple md change
  • Changeset (Changeset guidelines)
    • TODO (before merge)
    • Included (maybe it shouldn't be... 🤷 I'm totally happy with removing it if it's incorrect here)
    • Not necessary because:
  • Public documentation

@dario-piotrowicz dario-piotrowicz requested a review from a team as a code owner May 26, 2024 14:44
Copy link

changeset-bot bot commented May 26, 2024

🦋 Changeset detected

Latest commit: 71baeb1

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 4 packages
Name Type
miniflare Patch
@cloudflare/pages-shared Patch
@cloudflare/vitest-pool-workers Patch
wrangler Patch

Not sure what this means? Click here to learn what changesets are.

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

Copy link
Contributor

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/9244105747/npm-package-wrangler-5921

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

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

Or you can use npx with this latest build directly:

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

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


wrangler@3.57.1 includes the following runtime dependencies:

Package Constraint Resolved
miniflare workspace:* 3.20240512.0
workerd 1.20240512.0 1.20240512.0
workerd --version 1.20240512.0 2024-05-12

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

@CarmenPopoviciu CarmenPopoviciu merged commit e0e7725 into main May 30, 2024
19 checks passed
@CarmenPopoviciu CarmenPopoviciu deleted the miniflare-local-workerd-doc branch May 30, 2024 13:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

None yet

2 participants