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

Vite plugin README updates #7837

Merged
merged 3 commits into from
Jan 21, 2025
Merged

Vite plugin README updates #7837

merged 3 commits into from
Jan 21, 2025

Conversation

jamesopstad
Copy link
Contributor

Fixes #000.

Two changes to the README:

  • Fixes a broken link
  • Uses the default prettier config for code examples

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

@jamesopstad jamesopstad added the vite-plugin Relating to the `@cloudflare/vite-plugin` package label Jan 21, 2025
@jamesopstad jamesopstad requested a review from a team as a code owner January 21, 2025 08:24
Copy link

changeset-bot bot commented Jan 21, 2025

⚠️ No Changeset found

Latest commit: 4d35f0d

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

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/12882859489/npm-package-wrangler-7837

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

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

Or you can use npx with this latest build directly:

npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/12882859489/npm-package-wrangler-7837 dev path/to/script.js
Additional artifacts:

cloudflare-workers-bindings-extension:

wget https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/12882859489/npm-package-cloudflare-workers-bindings-extension-7837 -O ./cloudflare-workers-bindings-extension.0.0.0-v4f77015b5.vsix && code --install-extension ./cloudflare-workers-bindings-extension.0.0.0-v4f77015b5.vsix

create-cloudflare:

npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/12882859489/npm-package-create-cloudflare-7837 --no-auto-update

@cloudflare/kv-asset-handler:

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/12882859489/npm-package-cloudflare-kv-asset-handler-7837

miniflare:

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/12882859489/npm-package-miniflare-7837

@cloudflare/pages-shared:

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/12882859489/npm-package-cloudflare-pages-shared-7837

@cloudflare/unenv-preset:

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/12882859489/npm-package-cloudflare-unenv-preset-7837

@cloudflare/vite-plugin:

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/12882859489/npm-package-cloudflare-vite-plugin-7837

@cloudflare/vitest-pool-workers:

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/12882859489/npm-package-cloudflare-vitest-pool-workers-7837

@cloudflare/workers-editor-shared:

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/12882859489/npm-package-cloudflare-workers-editor-shared-7837

@cloudflare/workers-shared:

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/12882859489/npm-package-cloudflare-workers-shared-7837

@cloudflare/workflows-shared:

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/12882859489/npm-package-cloudflare-workflows-shared-7837

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


wrangler@3.103.2 includes the following runtime dependencies:

Package Constraint Resolved
miniflare workspace:* 3.20241230.2
workerd 1.20241230.0 1.20241230.0
workerd --version 1.20241230.0 2024-12-30

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

@@ -1,6 +1,6 @@
# `@cloudflare/vite-plugin`

[Intro](#intro) | [Quick start](#quick-start) | [Tutorial](#tutorial) | [API](#api) | [Cloudflare environments](#worker-environments) | [Migrating from `wrangler dev`](#migrating-from-wrangler-dev)
[Intro](#intro) | [Quick start](#quick-start) | [Tutorial](#tutorial) | [API](#api) | [Cloudflare environments](#cloudflare-environments) | [Migrating from `wrangler dev`](#migrating-from-wrangler-dev)
Copy link
Contributor

Choose a reason for hiding this comment

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

Good spot. Sorry I missed this before.

@petebacondarwin petebacondarwin merged commit 29f2076 into main Jan 21, 2025
42 of 44 checks passed
@petebacondarwin petebacondarwin deleted the james/readme-changes branch January 21, 2025 10:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no-changeset-required vite-plugin Relating to the `@cloudflare/vite-plugin` package
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants