Added debug messages and comments

Author: intisy

src/main/java/io/github/intisy/gradle/github/GithubExtension.java

@@ -3,31 +3,52 @@
 import java.io.File;
 import java.nio.file.Path;
 
+/**
+ * Extension for configuring GitHub integration.
+ */
 @SuppressWarnings("unused")
 public class GithubExtension {
     private String accessToken;
     private boolean debug;
 
+    /**
+     * @param debug Whether to enable debug logging.
+     */
     public void setDebug(boolean debug) {
         this.debug = debug;
     }
 
+    /**
+     * @return Whether debug logging is enabled.
+     */
     public boolean isDebug() {
         return debug;
     }
 
+    /**
+     * @param accessToken The path to the access token.
+     */
     public void setAccessToken(Path accessToken) {
         this.accessToken = accessToken.toString();
     }
 
+    /**
+     * @param accessToken The file containing the access token.
+     */
     public void setAccessToken(File accessToken) {
         this.accessToken = accessToken.toString();
     }
 
+    /**
+     * @param accessToken The access token.
+     */
     public void setAccessToken(String accessToken) {
         this.accessToken = accessToken;
     }
 
+    /**
+     * @return The access token.
+     */
     public String getAccessToken() {
         return accessToken;
     }

src/main/java/io/github/intisy/gradle/github/Logger.java

@@ -1,40 +1,91 @@
 package io.github.intisy.gradle.github;
 
 import org.gradle.api.Project;
-import org.gradle.api.logging.LogLevel;
 
+/**
+ * A logger for the GitHub plugin.
+ */
 public class Logger {
+    private static final String PREFIX = "[GitHub] ";
     private final GithubExtension extension;
-    private final Project project;
+    private final org.gradle.api.logging.Logger gradleLogger;
 
+    /**
+     * Creates a new logger.
+     * @param project The project.
+     */
     public Logger(Project project) {
         this(project.getExtensions().getByType(GithubExtension.class), project);
     }
 
+    /**
+     * Creates a new logger.
+     * @param extension The GitHub extension.
+     * @param project The project.
+     */
     public Logger(GithubExtension extension, Project project) {
         if (extension == null || project == null) {
             throw new NullPointerException("extension and project cannot be null");
         }
         this.extension = extension;
-        this.project = project;
+        this.gradleLogger = project.getLogger();
     }
 
+    /**
+     * Logs a standard lifecycle message, visible in the default Gradle output.
+     * @param message The message to log.
+     */
     public void log(String message) {
-        project.getLogger().lifecycle(message);
+        gradleLogger.lifecycle(PREFIX + message);
     }
 
+    /**
+     * Logs an error message.
+     * @param message The message to log.
+     */
     public void error(String message) {
-        project.getLogger().error(message);
+        gradleLogger.error(PREFIX + message);
     }
 
+    /**
+     * Logs an error message along with an exception's stack trace.
+     * @param message The message to log.
+     * @param throwable The exception to log.
+     */
+    public void error(String message, Throwable throwable) {
+        gradleLogger.error(PREFIX + message, throwable);
+    }
+
+    /**
+     * Logs a debug message.
+     * <p>
+     * This message will be shown at the LIFECYCLE level (visible by default) only if
+     * the user sets `github.debug = true` in their build script, providing an easy
+     * way to enable verbose logging for this plugin specifically.
+     * @param message The message to log.
+     */
     public void debug(String message) {
-        LogLevel logLevel = project.getGradle().getStartParameter().getLogLevel();
-        if (extension.isDebug() || logLevel.equals(LogLevel.INFO) || logLevel.equals(LogLevel.DEBUG)) {
-            project.getLogger().lifecycle(message);
+        if (extension.isDebug()) {
+            gradleLogger.lifecycle(PREFIX + "[DEBUG] " + message);
+        } else {
+            gradleLogger.debug(PREFIX + message);
         }
     }
 
+    /**
+     * Logs a warning message.
+     * @param message The message to log.
+     */
     public void warn(String message) {
-        project.getLogger().warn(message);
+        gradleLogger.warn(PREFIX + message);
+    }
+
+    /**
+     * Logs a warning message along with an exception's stack trace.
+     * @param message The message to log.
+     * @param throwable The exception to log.
+     */
+    public void warn(String message, Throwable throwable) {
+        gradleLogger.warn(PREFIX + message, throwable);
     }
-}
+}

src/main/java/io/github/intisy/gradle/github/ResourcesExtension.java

@@ -1,45 +1,76 @@
 package io.github.intisy.gradle.github;
 
+/**
+ * Extension for configuring external resources to be used in the project.
+ */
 @SuppressWarnings("unused")
 public class ResourcesExtension {
     private String branch = "main";
     private String path = "/";
     private String repoUrl;
     private boolean buildOnly;
 
+    /**
+     * @return Whether to only build the resources without including them in the project.
+     */
     public boolean isBuildOnly() {
         return buildOnly;
     }
 
+    /**
+     * @param buildOnly Whether to only build the resources without including them in the project.
+     */
     public void setBuildOnly(boolean buildOnly) {
         this.buildOnly = buildOnly;
     }
 
+    /**
+     * @param repoUrl The URL of the repository.
+     * @deprecated Use {@link #setRepoUrl(String)} instead.
+     */
     @Deprecated
     public void setRepo(String repoUrl) {
         setRepoUrl(repoUrl);
     }
 
+    /**
+     * @param repoUrl The URL of the repository.
+     */
     public void setRepoUrl(String repoUrl) {
         this.repoUrl = repoUrl;
     }
 
+    /**
+     * @return The URL of the repository.
+     */
     public String getRepoUrl() {
         return repoUrl;
     }
 
+    /**
+     * @return The branch of the repository to use.
+     */
     public String getBranch() {
         return branch;
     }
 
+    /**
+     * @param branch The branch of the repository to use.
+     */
     public void setBranch(String branch) {
         this.branch = branch;
     }
 
+    /**
+     * @return The path within the repository to the resources.
+     */
     public String getPath() {
         return path;
     }
 
+    /**
+     * @param path The path within the repository to the resources.
+     */
     public void setPath(String path) {
         this.path = path;
     }