prepare 0.0.5 release

gklijs · Apr 19, 2021 · 6ef8acf · 6ef8acf
1 parent f8c2eb5
commit 6ef8acf
Show file tree

Hide file tree

Showing 4 changed files with 58 additions and 6 deletions.
diff --git a/.github/workflows/java-release.yml b/.github/workflows/java-release.yml
@@ -18,12 +18,7 @@ jobs:
           gpg-private-key: ${{ secrets.OSSRH_GPG_SECRET_KEY }} # Value of the GPG private key to import
           gpg-passphrase: MAVEN_GPG_PASSPHRASE
       - name: Publish package
-        run: |
-          mvn \
-            --no-transfer-progress \
-            --batch-mode \
-            -Dgpg.passphrase=${{ secrets.OSSRH_GPG_SECRET_KEY_PASSWORD }} \
-            clean deploy
+        run: mvn deploy
         working-directory: java-client
         env:
           MAVEN_USERNAME: ${{ secrets.OSSRH_USERNAME }}

diff --git a/java-client/pom.xml b/java-client/pom.xml
@@ -127,10 +127,20 @@
 						<arg>loopback</arg>
 					</gpgArguments>
 				</configuration>
+				<executions>
+					<execution>
+						<id>sign-artifacts</id>
+						<phase>verify</phase>
+						<goals>
+							<goal>sign</goal>
+						</goals>
+					</execution>
+				</executions>
 			</plugin>
 			<plugin>
 				<groupId>org.apache.maven.plugins</groupId>
 				<artifactId>maven-source-plugin</artifactId>
+				<version>3.2.1</version>
 				<executions>
 					<execution>
 						<id>attach-sources</id>
@@ -142,6 +152,7 @@
 			</plugin>
 			<plugin>
 				<artifactId>maven-javadoc-plugin</artifactId>
+				<version>3.2.0</version>
 				<executions>
 					<execution>
 						<id>attach-javadoc</id>

diff --git a/java-client/src/main/java/tech/gklijs/bkes/client/BlockingClient.java b/java-client/src/main/java/tech/gklijs/bkes/client/BlockingClient.java
@@ -9,24 +9,47 @@
 import tech.gklijs.bkes.api.StartReply;
 import tech.gklijs.bkes.api.StartRequest;
 
+/**
+ * Implementation for a simple blocking client
+ */
 public class BlockingClient {
 
     private final BkesGrpc.BkesBlockingStub stub;
 
+    /**
+     * Creates a net blocking client
+     * @param host host of the bkes server
+     * @param port port of the bkes server
+     */
     public BlockingClient(String host, int port) {
         stub = BkesGrpc.newBlockingStub(
                 NettyChannelBuilder.forAddress(host, port).build()
         );
     }
 
+    /**
+     * Start a new aggregate
+     * @param request data to start
+     * @return error or succes
+     */
     public StartReply start(StartRequest request){
         return stub.start(request);
     }
 
+    /**
+     * Add to an aggregate
+     * @param request data to add
+     * @return error or succes
+     */
     public AddReply add(AddRequest request){
         return stub.add(request);
     }
 
+    /**
+     * Retrieve all the records for the key
+     * @param request data to retrieve
+     * @return error or success
+     */
     public RetrieveReply retrieve(RetrieveRequest request){
         return stub.retrieve(request);
     }

diff --git a/java-client/src/main/java/tech/gklijs/bkes/client/FutureClient.java b/java-client/src/main/java/tech/gklijs/bkes/client/FutureClient.java
@@ -10,24 +10,47 @@
 import tech.gklijs.bkes.api.StartReply;
 import tech.gklijs.bkes.api.StartRequest;
 
+/**
+ * Client working with futures for async processing
+ */
 public class FutureClient {
 
     private final BkesGrpc.BkesFutureStub stub;
 
+    /**
+     * Creates a new future client
+     * @param host host of bkes server
+     * @param port port of bkes server
+     */
     public FutureClient(String host, int port) {
         stub = BkesGrpc.newFutureStub(
                 NettyChannelBuilder.forAddress(host, port).build()
         );
     }
 
+    /**
+     * Start an aggregate
+     * @param request data to start
+     * @return success or error
+     */
     public ListenableFuture<StartReply> start(StartRequest request) {
         return stub.start(request);
     }
 
+    /**
+     * Add to aggregate
+     * @param request data to add
+     * @return success or error
+     */
     public ListenableFuture<AddReply> add(AddRequest request) {
         return stub.add(request);
     }
 
+    /**
+     * Retrieve al records with a key
+     * @param request data to retrieve
+     * @return success or error
+     */
     public ListenableFuture<RetrieveReply> retrieve(RetrieveRequest request) {
         return stub.retrieve(request);
     }