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

Raise awareness of version upgrade strategies #3935

Open
sbrannen opened this issue Aug 24, 2024 · 2 comments · May be fixed by #4244
Open

Raise awareness of version upgrade strategies #3935

sbrannen opened this issue Aug 24, 2024 · 2 comments · May be fixed by #4244

Comments

@sbrannen
Copy link
Member

After we release a new version of JUnit 5, there are always users who encounter issues while upgrading the JUnit versions used in the projects.

As @scordio pointed out in #3933 (comment), we should raise awareness of the available version upgrade strategies.

Places we could that:

  • Release Notes
  • project README page
  • new issue overview page
  • new issue templates
  • pinning a related issue with an obvious issue title
@mpkorstanje
Copy link
Contributor

mpkorstanje commented Aug 28, 2024

It might be worth while to have the JUnit Platform check at startup if all its dependencies are at the right version. And if not, log a warning that directs people to the documentation.

People typically don't read documentation up front, but they do read error messages.

@marcphilipp marcphilipp self-assigned this Jan 3, 2025
marcphilipp added a commit that referenced this issue Jan 12, 2025
The Launcher now checks for classpath alignment in case a LinkageError
such as a ClassNotFoundError is thrown from one of the methods of the
Launcher or TestEngine interfaces. If it finds unaligned versions, it
wraps the LinkageError in a JUnitException with a message listing the
detected versions and a link to the User Guide.

Resolves #3935.
@marcphilipp marcphilipp linked a pull request Jan 12, 2025 that will close this issue
@marcphilipp
Copy link
Member

I've submitted #4244 to address this. Please see the PR description for details.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment