Skip to content

Move @cloudflare/config package to 1.0 RC - #16907

Merged
petebacondarwin merged 1 commit into
mainfrom
james/config-rc-api
Nov 16, 2026
Merged

petebacondarwin merged 1 commit into
mainfrom
james/config-rc-api

Conversation

@jamesopstad

Copy link
Copy Markdown
Contributor

Release the 1.0 release candidate

This release finalises the binding and Worker field names, and includes breaking changes:

  • firstPartyWorker moves from the Worker's top level to experimental.firstPartyWorker.
  • bindings.pipeline() takes streamId in place of name. Set it to the ID of the Pipelines stream, not its name. Legacy pipelines aren't supported.
  • bindings.k2() takes id in place of stream. Set it to the ID of the K2 stream.
  • bindings.analytics() is renamed to bindings.analyticsSql(). Its binding type changes from "analytics" to "analytics-sql". The AnalyticsSQLBinding, AnalyticsSQLBindingOptions and AnalyticsSQLBindingSchema exports are renamed to AnalyticsSqlBinding, AnalyticsSqlBindingOptions and AnalyticsSqlBindingSchema.
  • The KVBindingSchema export is renamed to KvBindingSchema.
  • The config schemas and their parsed types are renamed after what they describe. The Input and Output prefixes are replaced by the public type names and BuildOutput:
    • InputConfigSchema → CloudflareConfigSchema, ParsedInputConfig → ParsedCloudflareConfig
    • InputSettingsSchema → SettingsSchema, ParsedInputSettingsConfig → ParsedSettings
    • InputWorkerSchema → WorkerConfigSchema, ParsedInputWorkerConfig → ParsedWorkerConfig
    • InputContainerSchema → ContainerConfigSchema, ParsedInputContainerConfig → ParsedContainerConfig
    • OutputRootConfigSchema → BuildOutputRootConfigSchema, ParsedOutputRootConfig → ParsedBuildOutputRootConfig
    • OutputWorkerSchema → BuildOutputWorkerConfigSchema, ParsedOutputWorkerConfig → ParsedBuildOutputWorkerConfig
    • OutputContainerSchema → BuildOutputContainerConfigSchema, ParsedOutputContainerConfig → ParsedBuildOutputContainerConfig

The new InputCloudflareConfig type is what CloudflareConfigSchema accepts, in the same way that InputWorkerConfig is what WorkerConfigSchema accepts.

Setting the old name or stream field fails with an error that names the replacement field. Editors also show both fields as deprecated.

The schema no longer fills in defaults. A parsed config without Containers leaves containers undefined instead of setting it to [], and a Container without maxInstances leaves it undefined instead of setting it to 20. Deploying still uses 20 instances when maxInstances isn't set.

Queue consumer maxConcurrency no longer accepts null. Wrangler already rejected it.


  • Tests
    • Tests included/updated
    • Automated tests not possible - manual testing has been completed as follows:
    • Additional testing not necessary because:
  • Public documentation
    • Cloudflare docs PR(s):
    • Documentation not necessary because: docs updates to follow

A picture of a cute animal (not mandatory, but encouraged)

Loading
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.

3 participants