Skip to content

docs: document deprecation rationale for getPomFile/setPomFile#11680

Merged
elharo merged 6 commits intoapache:masterfrom
anukalp2804:docs-model-pomfile-deprecation
Feb 16, 2026
Merged

docs: document deprecation rationale for getPomFile/setPomFile#11680
elharo merged 6 commits intoapache:masterfrom
anukalp2804:docs-model-pomfile-deprecation

Conversation

@anukalp2804
Copy link
Contributor

Fixes #11674

Documents the deprecation rationale and recommended replacement for the model API methods getPomFile() and setPomFile(File).

This change is documentation-only and does not affect runtime behavior.

Build: mvn -DskipTests -pl api/maven-api-model -am verify

Following this checklist to help us incorporate your
contribution quickly and easily:

  • Your pull request should address just one issue, without pulling in other changes.
  • Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
  • Each commit in the pull request should have a meaningful subject line and body.
    Note that commits might be squashed by a maintainer on merge.
  • Write unit tests that match behavioral changes, where the tests fail if the changes to the runtime are not applied.
    This may not always be possible but is a best-practice.
  • Run mvn verify to make sure basic checks pass.
    A more thorough check will be performed on your pull request automatically.
  • You have run the Core IT successfully.

If your pull request is about ~20 lines of code you don't need to sign an
Individual Contributor License Agreement if you are unsure
please ask on the developers list.

To make clear that you license your contribution under
the Apache License Version 2.0, January 2004
you have to acknowledge this by using the following check-box.

@cstamas
Copy link
Member

cstamas commented Jan 31, 2026

This is again wrong, version 4.0.0 of Maven was not even released.

@anukalp2804
Copy link
Contributor Author

Thanks — you’re right. I’ve replaced the JavaDoc link with plain text in the .mdo file and kept the deprecation version-agnostic.

* The "script" language. Provided for compatibility with Maven 3.
*
* @deprecated Use {@link #RESOURCES} instead.
* @deprecated since 4.0.0.
Copy link
Contributor

Choose a reason for hiding this comment

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

This is pulling in changes from other PRs. remove from this PR

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for catching that — I’ve removed the unrelated Language.java changes so this PR now only contains the maven.mdo updates.

Copy link
Contributor

Choose a reason for hiding this comment

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

but it's once again including redundant info

Copy link
Contributor

@elharo elharo left a comment

Choose a reason for hiding this comment

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

needs to sync with master

@anukalp2804 anukalp2804 force-pushed the docs-model-pomfile-deprecation branch from f22b4c0 to 5399a8b Compare February 15, 2026 14:50
@anukalp2804
Copy link
Contributor Author

needs to sync with master

Rebased this branch on the latest upstream/master and resolved conflicts in Language.java. The previous changes were already present upstream, so duplicate commits were skipped to keep the history clean. Force-pushed the updated branch to sync the PR.

* The "script" language. Provided for compatibility with Maven 3.
*
* @deprecated Use {@link #RESOURCES} instead.
* @deprecated since 4.0.0.
Copy link
Contributor

Choose a reason for hiding this comment

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

but it's once again including redundant info

@anukalp2804
Copy link
Contributor Author

Thanks for the note. I kept a single @deprecated entry in the Javadoc with only the replacement reference, since the version is already specified via @Deprecated(since = "4.0.0"). Please let me know if you’d prefer a different format.

* Use {@link #getPomPath()} instead.
* @deprecated Use getPomPath() instead.
*/
@Deprecated
Copy link
Contributor

Choose a reason for hiding this comment

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

now you've lost since in the annotation

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for catching that. I’ve restored the since = "4.0.0" value in the @Deprecated annotation and kept a single Javadoc @deprecated entry with the replacement reference.

*
* @deprecated since 4.0.0.
* Use {@link #getPomPath()} instead.
* @deprecated Use getPomPath() instead.
Copy link
Contributor

Choose a reason for hiding this comment

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

We lost the {@link} with this change.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good catch, thanks. I’ve restored the {@link} reference in the deprecation Javadoc so the method remains properly linked.

@elharo elharo merged commit 8cbf02e into apache:master Feb 16, 2026
1 check passed
@github-actions
Copy link

@elharo Please assign appropriate label to PR according to the type of change.

@github-actions github-actions bot added this to the 4.1.0 milestone Feb 16, 2026
@elharo elharo added the documentation Improvements or additions to documentation label Feb 16, 2026
@anukalp2804
Copy link
Contributor Author

Thank you for the review and merge 🙂

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Deprecated model API methods lack documented rationale and replacement

4 participants