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

Add documentation describing how to update the plugin protocol #36592

Merged
merged 5 commits into from
Feb 28, 2025

Conversation

SarahFrench
Copy link
Member

Documenting the process for updating the protocol - thanks to @dbanck for help with the process around symlinks!

Target Release

N/A

CHANGELOG entry

  • This change is user-facing and I added a changelog entry.
  • This change is not user-facing.

@SarahFrench SarahFrench added the no-changelog-needed Add this to your PR if the change does not require a changelog entry label Feb 27, 2025
@SarahFrench SarahFrench marked this pull request as ready for review February 27, 2025 12:58
@SarahFrench SarahFrench requested a review from a team as a code owner February 27, 2025 12:58
jbardin
jbardin previously approved these changes Feb 27, 2025
Copy link
Member

@jbardin jbardin left a comment

Choose a reason for hiding this comment

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

I was just contemplating removing this whole mess of paperwork for protocol changes. The idea was that external groups could easily reference a specific point release for the protobbuf without pulling it from VCS, but it's created this whole mess of process and leads itself to either be forgotten or extra versions created, and we have no sane diffs for review.
Maybe we go back to minor releases editing the files in place?

@SarahFrench
Copy link
Member Author

I was just contemplating removing this whole mess of paperwork for protocol changes. The idea was that external groups could easily reference a specific point release for the protobbuf without pulling it from VCS, but it's created this whole mess of process and leads itself to either be forgotten or extra versions created, and we have no sane diffs for review. Maybe we go back to minor releases editing the files in place?

I feel too new to have an opinion. I can definitely see there's risk around accidentally making >1 new minor version per TF minor version and I'm not sure how that could be protected against (could make a GHA?). For now having this PR's write up is useful as a way to make this more accessible with its current process.

@SarahFrench SarahFrench requested a review from jbardin February 27, 2025 17:42
@jbardin
Copy link
Member

jbardin commented Feb 27, 2025

Yeah, the minor version thing can't be protected against, but I really just want regular diffs 😸

@SarahFrench SarahFrench merged commit 4facc97 into main Feb 28, 2025
8 checks passed
@SarahFrench SarahFrench deleted the sarah/document-protocol-update-process branch February 28, 2025 10:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no-changelog-needed Add this to your PR if the change does not require a changelog entry
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants