Document deprecation rationale for executeChangeLogCommand overloads

[anukalp2804]

Fixes #1344

Documents the rationale for the deprecation of the legacy
executeChangeLogCommand methods in AbstractChangeLogCommand and clarifies
that they are retained only for backward compatibility with existing SCM
provider implementations.

No functional behavior is changed. These methods remain deprecated and are
not recommended for use by new implementations.

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.

• I hereby declare this contribution to be licenced under the Apache License Version 2.0, January 2004
• In any other case, please file an Apache Individual Contributor License Agreement.

[slachiewicz]

This is not exactly true - we have in fact impl for this for git provider

[anukalp2804]

This is not exactly true - we have in fact impl for this for git provider

Thanks for the clarification. I’ve updated the Javadoc to reflect that some providers (such as Git) still implement this API while clarifying that it remains part of the legacy path and is primarily retained for backward compatibility.

[Copilot]

Pull request overview

This PR adds deprecation documentation to three overloaded executeChangeLogCommand methods in AbstractChangeLogCommand. The documentation explains that these methods are part of a legacy API retained for backward compatibility with existing SCM provider implementations.

• Adds detailed JavaDoc explaining the rationale for deprecating legacy changelog command execution methods
• Clarifies that some providers (e.g., Git) still use the original abstract method
• Notes that the two concrete overloads often throw ScmException and are not widely supported

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

The deprecation notice should reference the replacement API method. Consider adding a reference to the newer method using @link. For example: "Providers that still rely on it should consider migrating to {@link #executeChangeLogCommand(ChangeLogScmRequest)} instead."

[anukalp2804]

Just checking in on this PR. It has been idle for a while and is still awaiting workflow approval and review.

[anukalp2804]

Hi @slachiewicz ,

Just a gentle follow-up on this PR.
Happy to adjust the wording or add references if you feel anything needs clarification.

Thanks for your time.