Migration guides

Migrate from remote generation alpha

The remote generation alpha was deprecated as of April 30, 2023. Please migrate to remote plugins or generated SDKs.

The remote generation alpha included two features: remote plugin execution (now called remote plugins), and remote code execution (now called generated SDKs). This document describes the changes and migration requirements for each feature.

Plugin changes

Public plugins are now solely maintained by the Buf team

In the alpha, public plugins could be uploaded by individual users with no verification. This caused a subpar experience for users who discovered plugins on their own, and also caused a security headache for some of our customers. All public remote plugins are now maintained and verified by the Buf team directly.

To see all publicly-available plugins, go to buf.build/plugins. We think we've covered the vast majority of use casesβ€”however, if you find a useful plugin that should be added, please file an issue!

Custom plugins available for Pro and Enterprise customers

The BSR will still allow you to upload custom private plugins. This feature is available for our Pro and Enterprise users. Contact us if you are interested in working with us!

Migrate to remote plugins

The documentation for remote plugins (the update to remote plugin execution) has the usage details. It's extremely similar to the alpha, but there are a few changes to the buf.gen.yaml file to note:

  1. The name and remote keys used to reference plugins changed to just plugin. The plugin key understands both local and remote references. Requires buf CLI version 1.8 or later.
  2. When referencing remote plugins, remove the /plugins/ path.
  3. Remove any revision numbers (the revision is now a separate key and typically not specified).

Full example covering all changes:

plugins:
-  - remote: buf.build/bufbuild/plugins/connect-go:v1.3.1-1
+  - plugin: buf.build/connectrpc/go:v1.3.1

Migrate to generated SDKs

The documentation for generated SDKs (the update to remote code execution) fully covers its usage. This section walks you through what changed, and outlines exactly how to migrate from remote code execution to generated SDKs.

Templates removed

Templates were a complex concept for users to understand when interacting with the BSR, so we removed them. Instead, you reference plugins directly by name (and plugins can depend on the output of other plugins). A list of publicly-available plugins can be found at buf.build/plugins. Note that not all plugins can be used with generated SDKsβ€”check the individual plugin for more details.

Versioning

The synthetic versioning scheme has been replaced by a more explicit versioning scheme comprised of the plugin version, module reference (datetime+short commit name) and revision. Example:

0.4.0-20220908151351-622fe7149695.1

This new semver-compatible versioning scheme can be pinned in lock files and always references a specific plugin + module for reproducibility.

Most users fetch the @latest version and will be unaffected by the versioning change.

Go module proxy

There are a couple of key changes from the alpha:

  • The base URL has changed from go.buf.build to buf.build/gen/go.
  • The path has changed to begin with the module name.
  • The template reference in the path has been replaced with plugins and moved to the end.
  • The version has changed to include plugin version and module commit information.

The new format is:

buf.build/gen/go/{moduleOwner}/{moduleName}/{pluginOwner}/{pluginName}

- go.buf.build/protocolbuffers/go/acme/petapis
+ buf.build/gen/go/acme/petapis/protocolbuffers/go

This means you'll need to search and replace the old import path with the new one and run go mod tidy.

The versioning has also changed to a more descriptive form:

{pluginVersion}-{moduleCommitTimestamp}-{moduleCommitName}.{pluginRevision}

Instead of relying on the commit sequence, it now relies directly on commits. For ways to pin to a commit and other documentation please see the new [Go proxy][../bsr/remote-plugins/go.mdx#using-go-modules] docs.

connect-go template

If you've used the connect-go template you'll need to update all connect imports to the generated code of the connect plugin.

The go.mod file also now requires two different imports, one for the go plugin and the other for the connect-go plugin.

go
- go.buf.build/connectrpc/go/acme/petapis
+ buf.build/gen/go/acme/petapis/protocolbuffers/go
+ buf.build/gen/go/acme/petapis/connectrpc/go

Example:

package main

import (
-  petv1 "go.buf.build/connectrpc/go/acme/petapis/pet/v1"
-  petv1connect "go.buf.build/connectrpc/go/acme/petapis/pet/v1/petv1connect"
+  petv1 "buf.build/gen/go/acme/petapis/protocolbuffers/go/pet/v1"
+  petv1connect "buf.build/gen/go/acme/petapis/connectrpc/go/pet/v1/petv1connect"
)

grpc-go template

If you've used the grpc-go template you'll need to update all grpc imports to the generated code of the grpc plugin.

The go.mod file also now requires two different imports, one for the go plugin and the other for the grpc-go plugin.

go
- go.buf.build/grpc/go/acme/petapis
+ buf.build/gen/go/acme/petapis/protocolbuffers/go
+ buf.build/gen/go/acme/petapis/grpc/go

We patched the grpc-go plugin to generate code to a subpackage. It previously generated code to the same package as the go plugin. The new import path is a subpackage that is named in the format: {goPackageName}grpc

Example:

package main

import (
-  petv1 "go.buf.build/grpc/go/acme/petapis/pet/v1"
+  petv1 "buf.build/gen/go/acme/petapis/protocolbuffers/go/pet/v1"
+  petv1grpc "buf.build/gen/go/acme/petapis/grpc/go/pet/v1/petv1grpc"
)

func main() {
  ...
-  client := petv1.NewPetStoreServiceClient(conn)
+  client := petv1grpc.NewPetStoreServiceClient(conn)
  res, err := client.GetPet(ctx, &petv1.GetPetRequest{})
  ...
}

protoc-gen-validate plugin

If you used a custom template that included the protoc-gen-validate plugin, there is no current direct migration path. We've taken stewardship of protoc-gen-validate from the Envoy team, and will continue to work to improve it, but protoc-gen-validate generated code is required to be generated to the same package as protoc-gen-go code, which doesn't fit cleanly into the generated SDKs model. In the meantime, switch to remote plugins using buf generate.

protoc-gen-grpc-gateway plugin

If you used a custom template that included the grpc-gateway plugin, you can update grpc-gateway imports to the generated code of the grpc-gateway plugin.

The go.mod file also now requires three different imports, for the go plugin, the grpc-go plugin, and the grpc-gateway plugin.

go
- go.buf.build/grpc-ecosystem/gateway/acme/petapis
+ buf.build/gen/go/acme/petapis/protocolbuffers/go
+ buf.build/gen/go/acme/petapis/grpc/go
+ buf.build/gen/go/acme/petapis/grpc-ecosystem/gateway/v2

We patched the grpc-gateway plugin to generate code to a subpackage. It previously generated code to the same package as the go and grpc-go plugins. The new import path is a subpackage that's named in the format: {goPackageName}gateway

The import path for the grpc-gateway plugin generated code changes like so:

package main

import (
-  petv1 "go.buf.build/grpc/go/acme/petapis/pet/v1"
+  petv1gateway "buf.build/gen/go/acme/petapis/grpc-ecosystem/gateway/v2/pet/v1/petv1gateway"
)

BSR NPM registry

Base URL

The base URL for the BSR NPM registry has changed, so you need to update your .npmrc file:

- @buf:registry=https://npm.buf.build
+ @buf:registry=https://buf.build/gen/npm/v1

Naming convention

The naming convention has changed because templates were removed in favor of plugins. The new format is:

{moduleOwner}_{moduleName}.{pluginOwner}_{pluginName}

Note that the dot (.) delimiter is used to break up the module and the plugin components.

This means you'll need to do 2 things:

  1. npm remove the old package and npm install the new package
  2. Search and replace application imports
- npm install @buf/bufbuild_es_connectrpc_eliza
+ npm install @buf/connectrpc_eliza.bufbuild_es

New documentation is available at NPM registry.

connect-web template

If you consumed connect-web template you'll need to update all imports for base types within your application code. This plugin now outputs plugin dependencies, namely protobuf-es, into a separate package.

Also, please note that the connect-web plugin has been renamed to connect-es. As a result, this plugin now outputs files with a _connect suffix rather than _connectweb.

Show example

One package (old behavior)

- node_modules
- └── @buf
-     └── bufbuild_connect-es_connectrpc_eliza
-         β”œβ”€β”€ connectrpc
-         β”‚   └── eliza
-         β”‚       └── v1
-         β”‚           β”œβ”€β”€ eliza_connectweb.d.ts
-         β”‚           β”œβ”€β”€ eliza_connectweb.js
-         β”‚           β”œβ”€β”€ eliza_pb.d.ts
-         β”‚           └── eliza_pb.js
-         └── package.json

Two packages (new behavior)

+ node_modules
+ └── @buf
+     β”œβ”€β”€ connectrpc_eliza.bufbuild_connect-es
+     β”‚   β”œβ”€β”€ connectrpc
+     β”‚   β”‚   └── eliza
+     β”‚   β”‚       └── v1
+     β”‚   β”‚           β”œβ”€β”€ eliza_connect.d.ts
+     β”‚   β”‚           └── eliza_connect.js
+     β”‚   └── package.json
+     └── connectrpc_eliza.bufbuild_es
+         β”œβ”€β”€ connectrpc
+         β”‚   └── eliza
+         β”‚       └── v1
+         β”‚           β”œβ”€β”€ eliza_pb.d.ts
+         β”‚           └── eliza_pb.js
+         └── package.json

Using this example, there are two important things to note, assuming you have run npm uninstall and npm install based on the naming change mentioned above.

  • If your application code imported eliza_pb.js from @buf/bufbuild_connect-es_connectrpc_eliza/eliza_connectweb.js, then you'll want to update that import within your application code to reference the base types from @buf/connectrpc_eliza.bufbuild_es/eliza_pb.js.
  • If your application code imported eliza_connectweb.js from @buf/bufbuild_connect-es_connectrpc_eliza/eliza_connectweb.js, then you'll want to update that import within your application code to reference the Connect artifacts from @buf/connectrpc_eliza.bufbuild_connect-es/eliza_connect.js.