Bump tfplugin version to 5.1 #21650
Bump tfplugin version to 5.1 #21650
Conversation
With the addition of the private field to ReadResource, we need to bump the proto version to 5.1.
| @@ -0,0 +1 @@ | |||
| ../../internal/tfplugin5/tfplugin5.proto | |||
There was a problem hiding this comment.
Hmm my instinct was to invert this and make the other location be the symlink, to make it clearer that these files are considered immutable once "released".
I'm not super against this model, but I worry a bit that it will make it easier to forget to deal with the versioning concerns when updating it, and thus to create a confusing/ambiguous situation.
There was a problem hiding this comment.
Oh, that works too! It won't help with the case where someone edits the file through the symlink in ./internal/tfplugin, but it makes the docs more of the "canonical source"
There was a problem hiding this comment.
Yeah... I was optimistically hoping that an editor would draw attention to the fact that's a symlink, but if not at least the eventual PR should show that there's an edit to a file called tfproto5.1 rather than the creation of a new file called tfproto5.2 and set of some ⏰ 😁
Add versioned tfplugin proto files to the docs directory, for easier reference. The latest version starts as a symlink to the current file used for generated the tfplugin package in ./internal/tfplugin5. When changing the protocol version, the old file must be copied to ./docs/plugin-protocol/, and a new symlink created for the latest version.
jbardin
force-pushed
the
jbardin/private-data-read
branch
from
3d3568d to
fa1f9be
Compare
|
I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues. If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further. |
ghost
locked and limited conversation to collaborators
#21611 added a new field to the
ReadResourceplugin method, which should also increment the minor version of the protocol.This also adds the proto definitions to the
./docs/plugin-protocol/directly, with filenames indication the full version for reference. The canonical file used to build the plugin package will still be located in the./internal/tfplugin5/directory, and be symlinked from./docs/plugin-protocol/to immediately reflect any minor format or textual changes. All previous versions of the file are considered frozen, and are only listed for reference.