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

docs: explicit EOL for previous releases #16263

Merged
merged 4 commits into from
Jul 24, 2024
Merged

docs: explicit EOL for previous releases #16263

merged 4 commits into from
Jul 24, 2024

Conversation

patak-dev
Copy link
Member

Description

We discussed with @sapphi-red and @dominikg about explicitly documenting our EOL policy (that right now isn't clear, not even between us).

This PR is a proposal that we agreed upon with them, and should help us keep the current low overhead maintenance of previous releases. We can do this only if we continue to be able to move the ecosystem quickly with us, so investment in vite-ecosystem-ci will keep being crucial.

If we merge this PR, we will announce in the Vite social accounts that Vite 2 will be in EOL once we release the next Vite minor to put a date from when we enforce the automatic EOL we are now declaring.

Copy link

stackblitz bot commented Mar 25, 2024

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@patak-dev patak-dev added p3-significant High priority enhancement (priority) documentation Improvements or additions to documentation labels Mar 25, 2024
dominikg
dominikg previously approved these changes Mar 25, 2024
sapphi-red
sapphi-red previously approved these changes Mar 25, 2024
antfu
antfu previously approved these changes Mar 25, 2024
docs/releases.md Outdated Show resolved Hide resolved
docs/releases.md Outdated
- Regular patches are released for `[email protected]`.
- Important fixes and security patches are backported to `vite@4` and `[email protected]`.
- Security patches are also backported to `vite@3` and `[email protected]`.
- `vite@2` and `[email protected]` reached their EOL.
Copy link
Member

Choose a reason for hiding this comment

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

A little bit scary to say that Vite 5.0 would already be EOL 😅 I'm not sure how to re-word it, but I suppose it's because we consider EOL on a minor level while other tools consider on the major level only.

Not a blocker though

Copy link
Member Author

Choose a reason for hiding this comment

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

Maybe we need a new name like "minor-EOL". I think it is good to be explicit, if we have 5.10, it doesn't scale to be backporting fixes to 5.0

Copy link
Member

Choose a reason for hiding this comment

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

Generally I don't think we have to backport fixes to different minors on the current major. I notice we do that for security fixes which felt a bit overkill. Minor/patches are non-breaking so there isn't a reason for them not to upgrade all the way to latest.

Copy link
Member Author

Choose a reason for hiding this comment

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

I think backporting security fixes at least to the prev 2 minors is a good idea given that some downstream projects may have the minor pinned because they are using experimental features. This has been very common in Nuxt for example. They should move as fast as they can though, so we only need the last one or two minors.
We could remove the explicit minor EOL, but I still prefer to have it so there is a clear contract with downstream projects.

Copy link
Member

Choose a reason for hiding this comment

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

If they pin the versions then they should also upgrade as soon as possible, otherwise EOL is only going to prolong it 😬 But anyways we can revise this again in the future, I'm ok with merging this for now.

Copy link
Member

Choose a reason for hiding this comment

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

I agree that EOL has a somewhat different connotation from, and sounds much stronger than "versions that will no longer receive updates". Usually it is only associated with major versions or entire projects.

Maybe this whole section should just be renamed "Supported Version Ranges", and instead of EOL, use "unsupported" or "no longer supported".

Since the range isn't always straightforward, we should probably:

  • Have a visualized graph that highlights currently supported versions (like the one at https://nodejs.org/en/about/previous-releases), ideally auto generated during VitePress build based on the latest Vite version.
  • Always list the versions that goes "unsupported" in future release posts.

@patak-dev patak-dev dismissed stale reviews from antfu and sapphi-red via 1f25366 April 11, 2024 05:31
Co-authored-by: Bjorn Lu <[email protected]>
docs/releases.md Outdated
- Regular patches are released for `[email protected]`.
- Important fixes and security patches are backported to `vite@4` and `[email protected]`.
- Security patches are also backported to `vite@3` and `[email protected]`.
- `vite@2` and `[email protected]` reached their EOL.
Copy link
Member

Choose a reason for hiding this comment

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

I agree that EOL has a somewhat different connotation from, and sounds much stronger than "versions that will no longer receive updates". Usually it is only associated with major versions or entire projects.

Maybe this whole section should just be renamed "Supported Version Ranges", and instead of EOL, use "unsupported" or "no longer supported".

Since the range isn't always straightforward, we should probably:

  • Have a visualized graph that highlights currently supported versions (like the one at https://nodejs.org/en/about/previous-releases), ideally auto generated during VitePress build based on the latest Vite version.
  • Always list the versions that goes "unsupported" in future release posts.

@patak-dev patak-dev disabled auto-merge April 11, 2024 14:59
@bluwy
Copy link
Member

bluwy commented Jul 24, 2024

Patak would you like to update this PR still?

@patak-dev
Copy link
Member Author

@bluwy I updated the PR to avoid the use of EOL. Let me know if the new wording makes sense to you.

About having a graph like Node has for EOL, I think that is more useful to know future dates as they are fixed in Node. Maybe could keep updating the "As an example" section for now everytime we do a release so we have the current range there. Or we could play with a graph in another PR if someone has a good idea for it.

Copy link
Member

@bluwy bluwy left a comment

Choose a reason for hiding this comment

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

Looks great 👍

@patak-dev patak-dev merged commit 4126db8 into main Jul 24, 2024
11 checks passed
@patak-dev patak-dev deleted the docs/releases-EOL branch July 24, 2024 12:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation p3-significant High priority enhancement (priority)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants