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

Extend migration guide for v2 #1328

Merged
merged 9 commits into from
Nov 19, 2024
Merged

Extend migration guide for v2 #1328

merged 9 commits into from
Nov 19, 2024

Conversation

timostamm
Copy link
Member

This extends the migration guide added in #1327 with:

  • more details and guidance on changes in Protobuf-ES v2
  • a path for upgrading generated SDKs
  • a "Gotchas" section for common pitfalls

- Use "name" instead of "path" when referring to npm package names.
- Link to BSR module for better context.
- Give example for changes to imports.

Signed-off-by: Timo Stamm <ts@timostamm.de>
- Update instructions for Generated SDKs
- Move all changes to buf.gen.yaml to one section
- Add tips, notes, and warnings where applicable
- Add diffs where applicable
- Add details on message methods, identifying messages, PlainMessage, PartialMessage, removal of toJSON
- Add details on reflection API changes
- Add "Gotchas" section
- Move requirements to the top

Signed-off-by: Timo Stamm <ts@timostamm.de>
Signed-off-by: Timo Stamm <ts@timostamm.de>
Signed-off-by: Timo Stamm <ts@timostamm.de>
Signed-off-by: Timo Stamm <ts@timostamm.de>
Signed-off-by: Timo Stamm <ts@timostamm.de>
Signed-off-by: Timo Stamm <ts@timostamm.de>
Signed-off-by: Timo Stamm <ts@timostamm.de>
@timostamm timostamm requested a review from smaye81 November 19, 2024 13:19
@timostamm timostamm merged commit 2eba85b into main Nov 19, 2024
44 checks passed
@timostamm timostamm deleted the tstamm/migrating-updates branch November 19, 2024 14:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants