add comments and configure maven publish

Author: LucasDFernandes

build.gradle

@@ -3,11 +3,13 @@ plugins {
 	id 'org.springframework.boot' version '3.4.5'
 	id 'io.spring.dependency-management' version '1.1.7'
 	id 'maven-publish'
+	id 'signing'
+	id 'org.jreleaser' version '1.18.0'
 }
 
 group = 'io.github.open-source-lfernandes'
 description = 'A Spring Boot starter for seamless integration with secret management services like AWS Secrets Manager, HashiCorp Vault, and more.'
-version = '1.0.5-SNAPSHOT'
+version = '1.0.0'
 
 java {
 	toolchain {
@@ -59,10 +61,44 @@ tasks.jar {
 	enabled = true
 }
 
+java {
+	withJavadocJar()
+	withSourcesJar()
+}
+
 publishing {
+	repositories {
+		maven {
+			url = layout.buildDirectory.dir('staging-deploy')
+		}
+	}
+
 	publications {
-		maven(MavenPublication) {
+		mavenJava(MavenPublication) {
 			from components.java
+			pom {
+				name = 'Spring Secret Starter'
+				description = 'A Spring Boot starter for seamless integration with secret management services like AWS Secrets Manager, HashiCorp Vault, and more.'
+				url = 'https://github.com/open-source-lfernandes/spring-secret-starter'
+				licenses {
+					license {
+						name = 'Apache License 2.0'
+						url = 'https://www.apache.org/licenses/LICENSE-2.0.txt'
+					}
+				}
+				developers {
+					developer {
+						id = 'open-source-lfernandes'
+						name = 'Lucas Fernandes'
+						email = '[email protected]'
+					}
+				}
+				scm {
+					connection = 'scm:git:git://github.com/open-source-lfernandes/spring-secret-starter.git'
+					developerConnection = 'scm:git:ssh://github.com:open-source-lfernandes/spring-secret-starter.git'
+					url = 'https://github.com/open-source-lfernandes/spring-secret-starter/tree/main'
+				}
+			}
 		}
 	}
-}
+}

src/main/java/io/github/open_source_lfernandes/spring_secret_starter/enums/Origin.java

@@ -5,5 +5,12 @@
  * It can be either AWS or CUSTOM.
  */
 public enum Origin {
-    AWS, CUSTOM
+    /**
+     * AWS indicates that the secret is sourced from AWS Secrets Manager.
+     */
+    AWS,
+    /**
+     * CUSTOM indicates that the secret is sourced from a custom provider.
+     */
+    CUSTOM
 }

src/main/java/io/github/open_source_lfernandes/spring_secret_starter/exceptions/NoneSecretProviderException.java

@@ -6,6 +6,11 @@
  * It extends RuntimeException and provides a constructor to set the error message.
  */
 public class NoneSecretProviderException extends RuntimeException {
+    /**
+     * Constructs a new NoneSecretProviderException with the specified detail message.
+     *
+     * @param message the detail message
+     */
     public NoneSecretProviderException(String message) {
         super(message);
     }

src/main/java/io/github/open_source_lfernandes/spring_secret_starter/exceptions/SecretNotFoundException.java

@@ -8,6 +8,12 @@
  */
 public class SecretNotFoundException extends Exception {
 
+    /**
+     * Constructs a new SecretNotFoundException with a message indicating
+     * that the secret with the specified key was not found.
+     *
+     * @param key the key of the secret that was not found
+     */
     public SecretNotFoundException(
         String key
     ) {

src/main/java/io/github/open_source_lfernandes/spring_secret_starter/messages/Messages.java

@@ -9,7 +9,13 @@
 @Getter
 public enum Messages {
 
+    /**
+     * Error messages used in the application.
+     */
     KEY_CANNOT_BE_NULL("Key cannot be null"),
+    /**
+     * Error message for when the secret value is null.
+     */
     ORIGIN_CANNOT_BE_BULL("Origin cannot be null");
 
     private final String description;