Skip to content

Pin links to user guide in javadoc to specific versions #5273

@mpkorstanje

Description

@mpkorstanje

In the current Javadoc JUnit always links to the /latest version of the user guide. This is annoying for two reasons:

  • When using an older version of JUnit, the user guide might describe features that are not yet available.
  • While documenting a feature and building the documentation locally, clicking links to the user in the Javadoc redirects to live version of that user guide that is missing unreleased features. This makes it harder to check if the cross references are correct.

Deliverables

  • Replace https://docs.junit.org/current in Javadoc with a link to the locally build documentation when building locally.
  • Replace https://docs.junit.org/current in Javadoc with a specific link to the released version when publishing releases

Metadata

Metadata

Assignees

No fields configured for Feature.

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions