update changelog and example readme

marcoferrer · Jan 4, 2019 · a3b5fe7 · a3b5fe7
1 parent f090999
commit a3b5fe7
Show file tree

Hide file tree

Showing 5 changed files with 73 additions and 8 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,16 @@
-## Version 0.2.2
-_2018-12-3_
+## Version 0.2.2-RC1
+_2018-01-03_
+* New: Update to kotlin ```1.3.11```
+
+#### Protoc Plugin
+* New: gRPC Coroutines Client & Server Code Generation 
+* New: Stand alone version of gRPC code gen. ```protoc-gen-grpc-coroutines```
+
+#### Coroutines
+* New: Benchmark implementation of gRPC coroutines
+* New: Experimental global dispatcher ```Dispatchers.Grpc```
+* Deprecated: ```InboundStreamChannel``` in favor of new stub APIs
+* Deprecated: ```ServerBidiCallChannel``` in favor of new stub APIs
 
 ## Version 0.2.1
 _2018-11-02_

diff --git a/build.gradle b/build.gradle
@@ -45,7 +45,7 @@ subprojects{ subproject ->
     apply plugin: 'kotlin'
 
     group = 'com.github.marcoferrer.krotoplus'
-    version = '0.2.2-SNAPSHOT'
+    version = '0.2.2-RC1'
 
     compileKotlin {
         kotlinOptions.jvmTarget = "1.8"

diff --git a/example-grpc-client-server/README.md b/example-grpc-client-server/README.md
@@ -10,7 +10,7 @@ cd kotlin-coroutines-gRPC-template && \
 ```
 
 ### Getting Started: Kroto+ Plugin
-_[Template](https://github.com/marcoferrer/kotlin-coroutines-gRPC-template/kroto-plus-template)_
+_[Template](https://github.com/marcoferrer/kotlin-coroutines-gRPC-template/tree/kroto-plus-template)_
 Add the following configuration to your existing Kroto configuration file.
 
 #### Asciipb (Proto Plain Text)
@@ -59,7 +59,61 @@ protobuf {
 }
 ```
 #### Maven
-_[Maven Template](https://github.com/marcoferrer/kotlin-coroutines-gRPC-template/maven)_
 ```xml
-TODO
+<plugin>
+    <groupId>org.xolstice.maven.plugins</groupId>
+    <artifactId>protobuf-maven-plugin</artifactId>
+    <version>0.6.1</version>
+    <configuration>
+        <protocArtifact>com.google.protobuf:protoc:3.6.1:exe:${os.detected.classifier}</protocArtifact>
+    </configuration>
+    <executions>
+        <execution>
+            <goals><goal>compile</goal></goals>
+        </execution>
+        <execution>
+            <id>grpc-java</id>
+            <goals><goal>compile-custom</goal></goals>
+            <configuration>
+                <pluginId>grpc-java</pluginId>
+                <pluginArtifact>io.grpc:protoc-gen-grpc-java:1.17.1:exe:${os.detected.classifier}</pluginArtifact>
+            </configuration>
+        </execution>
+
+        <execution>
+            <id>grpc-coroutines</id>
+            <goals>
+                <goal>compile-custom</goal>
+            </goals>
+            <configuration>
+                <pluginId>grpc-coroutines</pluginId>
+                <pluginArtifact>com.github.marcoferrer.krotoplus:protoc-gen-grpc-coroutines:0.2.2-RC1:jar:jvm8</pluginArtifact>
+            </configuration>
+        </execution>
+    </executions>
+</plugin>
+
+```
+Add generated sources to Kotlin plugin
+```xml
+<plugin>
+    <artifactId>kotlin-maven-plugin</artifactId>
+    <groupId>org.jetbrains.kotlin</groupId>
+    <version>${kotlin.version}</version>
+    <executions>
+        <execution>
+            <id>compile</id>
+            <goals>
+                <goal>compile</goal>
+            </goals>
+            <configuration>
+                <sourceDirs>
+                    <sourceDir>${project.basedir}/target/generated-sources/protobuf/grpc-java</sourceDir>
+                    <sourceDir>${project.basedir}/target/generated-sources/protobuf/grpc-coroutines</sourceDir>
+                </sourceDirs>
+            </configuration>
+        </execution>
+    </executions>
+</plugin>
+```
 ```
diff --git a/...rc/main/kotlin/com/github/marcoferrer/krotoplus/coroutines/CompletableDeferredResponse.kt b/...rc/main/kotlin/com/github/marcoferrer/krotoplus/coroutines/CompletableDeferredResponse.kt
@@ -3,7 +3,7 @@ package com.github.marcoferrer.krotoplus.coroutines
 import io.grpc.stub.StreamObserver
 import kotlinx.coroutines.CompletableDeferred
 
-class CompletableDeferredObserver<RespT>(
+class CompletableDeferredObserver<RespT> internal constructor(
     private val delegateObserver: StreamObserver<RespT>,
     private val delegateDeferred: CompletableDeferred<RespT> = CompletableDeferred()
 ) : CompletableDeferred<RespT> by delegateDeferred {

diff --git a/publishing.gradle b/publishing.gradle
@@ -85,7 +85,7 @@ publishing {
     }
 }
 
-//artifactoryPublish.skip = !(System.getenv('TRAVIS') == "true" && version.endsWith("SNAPSHOT"))
+artifactoryPublish.skip = !(System.getenv('TRAVIS') == "true" && version.endsWith("SNAPSHOT"))
 
 artifactory {