Skip to content

Conversation

olamy
Copy link
Member

@olamy olamy commented Aug 22, 2025

Signed-off-by: Olivier Lamy olamy@apache.org

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 integration tests successfully (mvn -Prun-its verify).

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.

olamy added 3 commits August 22, 2025 19:00
Signed-off-by: Olivier Lamy <olamy@apache.org>
Signed-off-by: Olivier Lamy <olamy@apache.org>
Signed-off-by: Olivier Lamy <olamy@apache.org>
@olamy olamy added the breaking Pull requests that break existing features label Aug 23, 2025
@olamy olamy added this to the 3.11.4 milestone Aug 23, 2025
@olamy olamy marked this pull request as ready for review August 23, 2025 08:01
Signed-off-by: Olivier Lamy <olamy@apache.org>
@olamy olamy changed the title WIP issue #1258 detectOfflineLinks is now false per default for all *jar* mojo issue #1258 Aug 24, 2025
@olamy olamy mentioned this pull request Aug 24, 2025

/**
* Detect the links for all modules defined in the project.
* <br/>
Copy link
Contributor

Choose a reason for hiding this comment

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

* If {@code reactorProjects} is defined in a non-aggregator way, it generates default offline links
* between modules based on the defined project's urls. For instance, if a parent project has two projects
* <code>module1</code> and <code>module2</code>, the <code>-linkoffline</code> will be:
* <br/>
Copy link
Contributor

Choose a reason for hiding this comment

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

* <br/>
* The added Javadoc <code>-linkoffline</code> parameter for <b>module1</b> will be
* <code>/absolute/path/to/</code><b>module2</b><code>/target/site/apidocs</code>
* <br/>
Copy link
Contributor

Choose a reason for hiding this comment

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

* @see #offlineLinks
* @since 2.6
*/
@Parameter(property = "detectOfflineLinks", defaultValue = "false")
Copy link
Contributor

Choose a reason for hiding this comment

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

why is this here instead of the superclass?

Copy link
Member Author

@olamy olamy Aug 26, 2025

Choose a reason for hiding this comment

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

because the role of this change is to have a default of false for *jar* mojos and leave parent as true

@olamy olamy modified the milestones: 3.11.4, 3.12.0 Aug 27, 2025
Signed-off-by: Olivier Lamy <olamy@apache.org>
@olamy olamy merged commit c8270f9 into apache:master Aug 28, 2025
100 checks passed
@olamy olamy deleted the issue/1258/detectOfflineLinks-forking-build branch August 28, 2025 21:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking Pull requests that break existing features
Projects
None yet
Development

Successfully merging this pull request may close these issues.

detectOfflineLinks should be false per default (at least for javadoc:jar)
2 participants