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

Finalise versioning in tags #387

Closed
muratabur opened this issue Jan 27, 2025 · 2 comments · Fixed by #388
Closed

Finalise versioning in tags #387

muratabur opened this issue Jan 27, 2025 · 2 comments · Fixed by #388

Comments

@muratabur
Copy link
Contributor

We now version the project with tags, so the "v1-dev" folder doesn't make sense, we will just call this schemas to avoid any confusion. A small semantic change, but will have breaking consequences if not handled properly.

Option 1:

  • just swap out /v1-dev with /schemas and warn in the release notes

Option 2:

  • keep backwards compatibility for a period.
  • copy /v1-dev and /schemas and push updates to both for 6months/1year

Option 3:

  • keep backwards compatibility but push new updates only to /schemas

I like 3 as it doesn't break things, but also doesn't encourage procrastination like 2 would.

@HubertBos
Copy link

HELLo

I want to suggest moving with Option 1. This will be painful at the beginning but later on, will fix itself rather than dragging something to infinity. ( Or option 2 if 1st one is not acceptable )

@muratabur
Copy link
Contributor Author

Thanks everyone for comments (publicly and privately). It seems we can do all three in stages. Option 2 for 6 months, this will then become Option 3 which will then become Option 1.

To summarize:

  1. Until June 2025 /v1-dev and /schemas will be identical, with new updates replicated across both.
  2. From June 2025 onwards, /v1-dev will stop receiving new updates so any legacy dependencies will continue working.
  3. At the end of 2025, /v1-dev will be deleted to complete the migration and legacy dependencies will stop working.

@muratabur muratabur linked a pull request Feb 1, 2025 that will close this issue
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 a pull request may close this issue.

2 participants