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

Write a HOWTO migrate Codec format version #12918

Open
slow-J opened this issue Dec 11, 2023 · 1 comment · May be fixed by #12930
Open

Write a HOWTO migrate Codec format version #12918

slow-J opened this issue Dec 11, 2023 · 1 comment · May be fixed by #12930

Comments

@slow-J
Copy link
Contributor

slow-J commented Dec 11, 2023

Description

The change to changing PFOR encoding to FOR for doc blocks in #12741, required bumping the Codec version from 95 to 99.

Bumping the Codec is not a straightforward process since it involved:

  • Forking all modified changed files and bumping the version number
  • Moving the original copies of the modified files to backwards_codecs
  • Re-generating ForUtil
    • + changes to forUtil.gradle to bump version and add a new task for regenerating backwards_codec
  • Forking PostingsFormat subclasses
  • Changes to tests:
    • Bumping existing Codec unit tests
    • Creating RW versions of old Codec and Codec components
    • Bumping Codec components where used throughout other tests

We required a few follow-ups to clean up the initial misses:

@mikemccand mentioned in #12904 (comment)

Codec format migrations are so tricky ... I wish we had a HOWTO somewhere.

Since I done the last Codec bump, I can have a look at writing up the documentation so subsequent codec format bumps will go smoother.

@shubhamvishu
Copy link
Contributor

Nice....This would be really helpful!

@slow-J slow-J linked a pull request Dec 12, 2023 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants