Copilot commented on code in PR #1350:
URL: https://github.com/apache/maven-scm/pull/1350#discussion_r2649094781
##########
maven-scm-api/src/main/java/org/apache/maven/scm/command/changelog/AbstractChangeLogCommand.java:
##########
@@ -45,6 +52,12 @@ protected abstract ChangeLogScmResult
executeChangeLogCommand(
String datePattern)
throws ScmException;
+ /**
+ * @deprecated This legacy overload is kept for backward compatibility.
+ * It may not be supported by all SCM providers and in many cases
+ * results in an {@link ScmException}. Providers that still rely on it
+ * should consider migrating to the newer changelog execution APIs.
+ */
Review Comment:
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."
##########
maven-scm-api/src/main/java/org/apache/maven/scm/command/changelog/AbstractChangeLogCommand.java:
##########
@@ -35,6 +35,13 @@
* @author Olivier Lamy
*/
public abstract class AbstractChangeLogCommand extends AbstractCommand
implements ChangeLogCommand {
+ /**
+ * @deprecated This method is part of the legacy changelog command
execution
+ * mechanism and is retained for backward compatibility with existing SCM
+ * provider implementations. Some providers (for example Git) still
implement
+ * this API, but newer code should rely on the current changelog handling
+ * logic provided by the SCM command framework instead.
+ */
Review Comment:
The deprecation notice should reference the replacement API method. Consider
adding a reference to the newer method using @link. For example: "Providers
should consider migrating to {@link
#executeChangeLogCommand(ChangeLogScmRequest)} instead."
##########
maven-scm-api/src/main/java/org/apache/maven/scm/command/changelog/AbstractChangeLogCommand.java:
##########
@@ -56,6 +69,12 @@ protected ChangeLogScmResult executeChangeLogCommand(
throw new ScmException("Unsupported method for this provider.");
}
+ /**
+ * @deprecated This legacy overload is kept for backward compatibility.
+ * It may not be supported by all SCM providers and in many cases
+ * results in an {@link ScmException}. Providers that still rely on it
+ * should consider migrating to the newer changelog execution APIs.
+ */
Review Comment:
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."
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
