fix: fix pom and the javadoc's notes to release (#3)

Change-Id: I6e29fd88d9cb45941d91af2ecee9971209b5bc49
larksuite · Nov 28, 2019 · c826791 · c826791
1 parent f8daf76
commit c826791
Show file tree

Hide file tree

Showing 8 changed files with 97 additions and 15 deletions.
diff --git a/appframework-sdk/pom.xml b/appframework-sdk/pom.xml
@@ -12,11 +12,11 @@
     <parent>
         <groupId>com.larksuite.appframework</groupId>
         <artifactId>appframework-parent</artifactId>
-        <version>1.0.0-SNAPSHOT</version>
+        <version>1.0.0</version>
     </parent>
 
     <artifactId>appframework-sdk</artifactId>
-    <version>1.0.0-SNAPSHOT</version>
+    <version>1.0.0</version>
 
     <dependencies>
         <dependency>

diff --git a/appframework-sdk/src/main/java/com/larksuite/appframework/sdk/AppConfiguration.java b/appframework-sdk/src/main/java/com/larksuite/appframework/sdk/AppConfiguration.java
@@ -20,6 +20,8 @@ public class AppConfiguration {
 
     /**
      * app short name defined by app developer
+     *
+     * @parm appShortName
      */
     private String appShortName;
 
@@ -46,11 +48,15 @@ public static void checkConfiguration(AppConfiguration c) {
     }
 
     /**
+     *
      * larksuite.appframework.${appName1}.appId=xxx
      * larksuite.appframework.${appName1}.appSecret=
      * larksuite.appframework.${appName1}.encryptKey=
      * larksuite.appframework.${appName1}.verificationToken=
      * larksuite.appframework.${appName1}.isIsv=true
+     * @param appShortName
+     * @param properties
+     * @return AppConfiguration
      */
     public static AppConfiguration loadFromProperties(String appShortName, Properties properties) {
 

diff --git a/appframework-sdk/src/main/java/com/larksuite/appframework/sdk/LarkAppInstance.java b/appframework-sdk/src/main/java/com/larksuite/appframework/sdk/LarkAppInstance.java
@@ -165,9 +165,11 @@ public String receiveLarkNotify(String notifyJsonData) {
 
 
     /**
+     *
      * called when receive card notify json data
      *
      * @param notifyJsonData data from lark notify request
+     * @param request
      * @return response data for sending back to lark synchronously
      */
     public String receiveCardNotify(String notifyJsonData, HttpServletRequest request) {

diff --git a/appframework-sdk/src/main/java/com/larksuite/appframework/sdk/client/ImageKeyManager.java b/appframework-sdk/src/main/java/com/larksuite/appframework/sdk/client/ImageKeyManager.java
@@ -73,11 +73,11 @@ public String registerImage(String imageName, InputStream imageContent) throws L
     /**
      * register a image for management.
      *
-     * @param tenantKey
+     * @param tenantKey user's tenantKey
      * @param imageName user defined unique name
-     * @param imageContent
+     * @param imageContent imageContent
      * @return imageKey
-     * @throws LarkClientException
+     * @throws LarkClientException throws a LarkClientException
      */
     public String registerImageIsv(String imageName, InputStream imageContent, String tenantKey) throws LarkClientException {
 

diff --git a/appframework-sdk/src/main/java/com/larksuite/appframework/sdk/client/LarkClient.java b/appframework-sdk/src/main/java/com/larksuite/appframework/sdk/client/LarkClient.java
@@ -27,8 +27,8 @@
  * botframework users should use this class to communicate with lark server
  * <p>
  * usually we don't create instance manually, just get the instance like this
+ * </p>
  * <code>
- * <p>
  * BotAppsServer botAppsServer; // create server by factory
  * LarkClient larkClient = botAppsServer.getLarkClient();
  * </code>
@@ -57,10 +57,10 @@ public LarkClient(InstanceContext instanceContext, OpenApiClient openApiClient)
      * send chat message as ISV
      *
      * @param dest      where will this message send to
-     * @param tenantKey
-     * @param message
-     * @return
-     * @throws LarkClientException
+     * @param tenantKey tenantKey
+     * @param message message
+     * @return messageId
+     * @throws LarkClientException throws a LarkClientException
      */
     public String sendChatMessageIsv(MessageDestination dest, Message message, String tenantKey) throws LarkClientException {
         checkAppType(true);

diff --git a/appframework-sdk/src/main/java/com/larksuite/appframework/sdk/client/SessionManager.java b/appframework-sdk/src/main/java/com/larksuite/appframework/sdk/client/SessionManager.java
@@ -16,8 +16,7 @@ public interface SessionManager {
 
     /**
      * call this method to turn on session info encryption with AES algorithm
-     * @param encryptKey
-     * @return
+     * @param encryptKey encryptKey
      */
     void turnOnEncryption(String encryptKey);
 
@@ -27,6 +26,11 @@ public interface SessionManager {
      */
     String saveSession(SessionInfo si);
 
+    /**
+     * get session with sessionId
+     * @param sessionId
+     * @return sessionInfo
+     */
     SessionInfo getSession(String sessionId);
 
     int getSessionMaxAge();

diff --git a/appframework-spring-boot-starter/pom.xml b/appframework-spring-boot-starter/pom.xml
@@ -11,14 +11,14 @@
     <parent>
         <groupId>com.larksuite.appframework</groupId>
         <artifactId>appframework-parent</artifactId>
-        <version>1.0.0-SNAPSHOT</version>
+        <version>1.0.0</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 
     <artifactId>appframework-spring-boot-starter</artifactId>
 
     <properties>
-        <appframework.sdk.version>1.0.0-SNAPSHOT</appframework.sdk.version>
+        <appframework.sdk.version>1.0.0</appframework.sdk.version>
         <spring.boot.version>2.1.9.RELEASE</spring.boot.version>
     </properties>
 

diff --git a/pom.xml b/pom.xml
@@ -13,7 +13,9 @@
     <groupId>com.larksuite.appframework</groupId>
     <artifactId>appframework-parent</artifactId>
     <packaging>pom</packaging>
-    <version>1.0.0-SNAPSHOT</version>
+    <version>1.0.0</version>
+    <name>larksuite-appframework-sdk-java</name>
+    <url>https://open.larksuite.com/</url>
 
     <modules>
         <module>appframework-sdk</module>
@@ -26,6 +28,43 @@
 
     </properties>
 
+    <distributionManagement>
+        <snapshotRepository>
+            <id>sonatype-nexus-snapshots</id>
+            <url>https://oss.sonatype.org/content/repositories/snapshots</url>
+        </snapshotRepository>
+        <repository>
+            <id>sonatype-nexus-staging</id>
+            <url>https://oss.sonatype.org/service/local/staging/deploy/maven2/</url>
+        </repository>
+    </distributionManagement>
+
+    <licenses>
+        <license>
+            <name>The MIT License</name>
+            <url>https://opensource.org/licenses/MIT</url>
+            <distribution>repo</distribution>
+        </license>
+    </licenses>
+    <scm>
+        <connection>scm:git:[email protected]:larksuite/appframework-java.git</connection>
+        <developerConnection>scm:git:ssh://github.com:larksuite/appframework-java.git</developerConnection>
+        <url>https://github.com/larksuite/appframework-java/tree/master</url>
+    </scm>
+    <developers>
+        <developer>
+            <id>larkopen</id>
+            <name>larkopen</name>
+            <email>[email protected]</email>
+        </developer>
+    </developers>
+
+    <parent>
+        <groupId>org.sonatype.oss</groupId>
+        <artifactId>oss-parent</artifactId>
+        <version>7</version>
+    </parent>
+
     <dependencies>
         <dependency>
             <groupId>org.projectlombok</groupId>
@@ -71,6 +110,37 @@
                     </execution>
                 </executions>
             </plugin>
+
+            <!-- Javadoc -->
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-javadoc-plugin</artifactId>
+                <version>2.9.1</version>
+                <executions>
+                    <execution>
+                        <phase>package</phase>
+                        <goals>
+                            <goal>jar</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+
+            <!-- GPG -->
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-gpg-plugin</artifactId>
+                <version>1.5</version>
+                <executions>
+                    <execution>
+                        <id>sign-artifacts</id>
+                        <phase>verify</phase>
+                        <goals>
+                            <goal>sign</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
         </plugins>
     </build>
 </project>