Skip to content

docs: clarify deprecation of RELEASE and LATEST version constants #11686

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.

Sign up for GitHub

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

Open
amahi1568 wants to merge 2 commits into
base: master
Choose a base branch
from
Open

docs: clarify deprecation of RELEASE and LATEST version constants #11686

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4b3c98a
docs: clarify deprecation of RELEASE and LATEST version constants
amahi1568 Jan 29, 2026
0884999
docs: correct deprecation since version for LATEST and RELEASE
amahi1568 Feb 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions compat/maven-artifact/src/main/java/org/apache/maven/artifact/Artifact.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,18 @@
*/
public interface Artifact extends Comparable<Artifact> {

@Deprecated(since = "4.0.0")
/**
* @deprecated since 3.0

@elharo elharo Feb 3, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

No need to duplicate the since parameter

* Use explicit version resolution instead of special version constants.
*/
@Deprecated(since = "3.0")

@gnodet gnodet May 21, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The since value should remain "4.0.0" — that is when the @Deprecated annotation was actually added to these constants. Changing it to "3.0" without evidence from the git history is inaccurate.

Also, the Javadoc asterisks are misaligned — they should use * (space-star) to match the project's formatting conventions:

Suggested change
@Deprecated(since = "3.0")
* @deprecated since 3.0
* Use explicit version resolution instead of special version constants.

should be (if kept at all):

Suggested change
@Deprecated(since = "3.0")
* @deprecated Since 4.0.0. Use explicit version resolution instead of special version constants.

String RELEASE_VERSION = "RELEASE";

@gnodet gnodet May 21, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Changing @Deprecated(since = "4.0.0") to @Deprecated(since = "3.0") is incorrect. The deprecation annotation was introduced in Maven 4.0.0. Please revert.

Suggested change
String RELEASE_VERSION = "RELEASE";
@Deprecated(since = "4.0.0")


@Deprecated(since = "4.0.0")
/**
* @deprecated since 3.0
* Use a fixed version or an explicit version range instead of special version tokens.

@elharo elharo Feb 3, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

never use version ranges

*/
@Deprecated(since = "3.0")
String LATEST_VERSION = "LATEST";

String SNAPSHOT_VERSION = "SNAPSHOT";
Expand Down
Loading