Skip to content

Bump version to 1.0 and update README.#8787

Merged
petebacondarwin merged 3 commits into
mainfrom
james/update-readme
Apr 4, 2025
Merged

Bump version to 1.0 and update README.#8787
petebacondarwin merged 3 commits into
mainfrom
james/update-readme

Conversation

@jamesopstad
Copy link
Copy Markdown
Contributor

Fixes #000.

Bump version to 1.0 and update README.


  • Tests
    • TODO (before merge)
    • Tests included
    • Tests not necessary because: no code changes
  • Wrangler / Vite E2E Tests CI Job required? (Use "e2e" label or ask maintainer to run separately)
    • I don't know
    • Required
    • Not required because: N/A
  • Public documentation
  • Wrangler V3 Backport
    • TODO (before merge)
    • Wrangler PR:
    • Not necessary because: N/A

@jamesopstad jamesopstad requested a review from a team April 4, 2025 11:59
@jamesopstad jamesopstad requested a review from a team as a code owner April 4, 2025 11:59
@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented Apr 4, 2025

🦋 Changeset detected

Latest commit: d9c8f09d190ab2ea0d758b9cdb4c9d9e15c0b0c9

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

This PR includes changesets to release 1 package
Name Type
@cloudflare/vite-plugin Major

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

@jamesopstad jamesopstad added the vite-plugin Relating to the `@cloudflare/vite-plugin` package label Apr 4, 2025
@github-project-automation github-project-automation Bot moved this to Untriaged in workers-sdk Apr 4, 2025
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 4, 2025

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/14266521444/npm-package-wrangler-8787

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

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

Or you can use npx with this latest build directly:

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

cloudflare-workers-bindings-extension:

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

create-cloudflare:

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

@cloudflare/kv-asset-handler:

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

miniflare:

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

@cloudflare/pages-shared:

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

@cloudflare/unenv-preset:

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

@cloudflare/vite-plugin:

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

@cloudflare/vitest-pool-workers:

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

@cloudflare/workers-editor-shared:

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

@cloudflare/workers-shared:

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

@cloudflare/workflows-shared:

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

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


wrangler@4.7.1 includes the following runtime dependencies:

Package Constraint Resolved
miniflare workspace:* 4.20250321.2
workerd 1.20250404.0 1.20250404.0
workerd --version 1.20250404.0 2025-04-04

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

- Leverages Vite's hot module replacement for consistently fast updates
- Supports `vite preview` for previewing your build output in the Workers runtime prior to deployment

## Quick start
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I feel like it might be kinda nice to keep a simple quick start here?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I could copy over the 'Get started' guide - https://developers.cloudflare.com/workers/vite-plugin/get-started/. What do you think?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I would avoid adding much. Perhaps just what the config looks like:

import { defineConfig } from "vite";
import { cloudflare } from "@cloudflare/vite-plugin";

export default defineConfig({
  plugins: [cloudflare()],
});

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Yeah, it's a tricky balance. The Vite config on its own isn't sufficient for doing anything but if we add much more then we end up duplicating a chunk of the docs and having to keep them in sync.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Yeah, I don't think the idea is that anything here would be useful in it own right. Instead it is like an illustration of what they the package does, so they know if it what they were looking for and whether to then go look at the docs.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

- Leverages Vite's hot module replacement for consistently fast updates
- Supports `vite preview` for previewing your build output in the Workers runtime prior to deployment

## Quick start
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I would avoid adding much. Perhaps just what the config looks like:

import { defineConfig } from "vite";
import { cloudflare } from "@cloudflare/vite-plugin";

export default defineConfig({
  plugins: [cloudflare()],
});

@github-project-automation github-project-automation Bot moved this from Untriaged to Approved in workers-sdk Apr 4, 2025
Comment thread .changeset/whole-candles-burn.md
Comment thread .changeset/whole-candles-burn.md Outdated
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

👍

@jamesopstad jamesopstad force-pushed the james/update-readme branch from d9c8f09 to 26d698b Compare April 4, 2025 13:31
@petebacondarwin petebacondarwin merged commit 3af2e30 into main Apr 4, 2025
@petebacondarwin petebacondarwin deleted the james/update-readme branch April 4, 2025 13:43
@github-project-automation github-project-automation Bot moved this from Approved to Done in workers-sdk Apr 4, 2025
@workers-devprod workers-devprod mentioned this pull request Apr 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

vite-plugin Relating to the `@cloudflare/vite-plugin` package

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

4 participants