ISSUE-32 Integration with Confluent Hub Release (#33)

* ISSUE-32 Integration with Confluent Hub Release
* build script change to create confluent release package
* docs folder rename to doc to be in sync with confluent release structue
* adobe logo added for release
* update github actions to include confluent release zip as release resources
* ISSUE-32 update owner name as "Adobe Inc."

Author: vivetiwa

.dockerignore

@@ -12,6 +12,6 @@
 
 .idea/
 .git/
-docs/
+doc/
 config/
 full-stack/

.github/workflows/build-release-master.yml

@@ -8,7 +8,7 @@ on:
 jobs:
   build:
     runs-on: ubuntu-latest
-    name: Build for ${{ matrix.Java }}
+    name: Build for 8 and 11
     steps:
       - uses: actions/checkout@v2
       - name: Set up JDK 11
@@ -18,17 +18,18 @@ jobs:
           distribution: 'adopt'
       - name: Grant execute permission for gradlew
         run: chmod +x gradlew
-      - name: Build with Gradle
-        run: |
-          export JAVA_COMPILATION_VERSION=11
-          ./gradlew build
-          export JAVA_COMPILATION_VERSION=8
-          ./gradlew build
       - name: Bump Release Version
         id: tag_version
         uses: mathieudutour/[email protected]
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
+      - name: Build with Gradle
+        run: |
+          export JAVA_COMPILATION_VERSION=8
+          export PROJECT_VERSION=${{ steps.tag_version.outputs.new_version }}
+          ./gradlew build
+          export JAVA_COMPILATION_VERSION=11
+          ./gradlew build kafkaConnectPublish
       - name: Create Release
         id: create_release
         uses: softprops/action-gh-release@v1
@@ -37,7 +38,20 @@ jobs:
         with:
           tag_name: ${{ steps.tag_version.outputs.new_tag }}
           name: ${{ steps.tag_version.outputs.new_tag }}
-          body: ${{ steps.tag_version.outputs.changelog }}
+          body: |
+            ${{ steps.tag_version.outputs.changelog }}
+            ## Confluent Archive Zip
+            Attached to this release is the adobe-streaming-connect-sink-${{ steps.tag_version.outputs.new_version }}.zip confluent archive - see the [confluent documentation](https://docs.confluent.io/home/connect/install.html) about installing a connector manually for more information.
+
+            ## All-In-One Dependency JAR
+            All in one dependency JAR could be used in place of multiple jars.
+            Following all-in-one AEP sink connector JAR are attached in release :
+            1. streaming-connect-sink-${{ steps.tag_version.outputs.new_version }}-java-8.jar  : Compiled with java 8
+            2. streaming-connect-sink-${{ steps.tag_version.outputs.new_version }}-java-11.jar : Compiled with java 11
+
+            For connector properties and sample connector configuration please refer : [Developer Guide](https://github.com/adobe/experience-platform-streaming-connect/blob/master/DEVELOPER_GUIDE.md)
           draft: true
           prerelease: false
-          files: ./streaming-connect-sink/build/libs/streaming-connect-sink-*.jar
+          files: |
+            ./streaming-connect-sink/build/libs/streaming-connect-sink-*.jar
+            ./build/distributions/adobe-streaming-connect-sink-*.zip

DEVELOPER_GUIDE.md

@@ -311,7 +311,7 @@ For reference, more details are in oracle documentation on configuring proxy set
 The docker setup comes with Topics UI to view the topic and messages within.
 Open a browser and go to http://localhost:8000 and view the connect-test topic
 
-![Topics UI](./docs/resources/topics-ui.png)
+![Topics UI](./doc/resources/topics-ui.png)
 
 In order to test the flow, you can use the following curl command to post a message into the Kafka topic using the
 Kafka rest proxy. Please ensure that the curl command uses your inlet endpoint, and the schema of the XDM message

README.md

@@ -22,7 +22,7 @@ Adobe Experience Platform Stream connector is based on Kafka Connect. Use this l
 
 AEP sink connector delivers data from Kafka topics to a registered endpoint of the Adobe Experience Platform.
 
-![AEP Sink Connector](./docs/resources/aep_sink_connector.png)
+![AEP Sink Connector](./doc/resources/aep_sink_connector.png)
 
 #### Features
 
@@ -58,7 +58,7 @@ We have included a quick-start script which automates configuration by creating
 
 Following figure illustrates steps simulated by setup script.
 
-![AEP Sink Connector setup](./docs/resources/aep_sink_connector_setup.png)
+![AEP Sink Connector setup](./doc/resources/aep_sink_connector_setup.png)
 
 #### Prerequisite
 * Install [Java 8][java-8]

build.gradle

@@ -38,6 +38,25 @@ repositories {
   mavenCentral()
 }
 
+def connectProperties = [
+  title              : 'Adobe Experience Platform Sink Connector',
+  componentName      : 'streaming-connect-sink',
+  documentationUrl   : 'https://github.com/adobe/experience-platform-streaming-connect',
+  sourceUrl          : 'https://github.com/adobe/experience-platform-streaming-connect',
+  description        : 'Adobe Experience Platform Stream connector is based on Kafka Connect. Use this library to stream JSON events from Kafka topics in your datacenter directly into a Adobe Experience Platform in real-time.',
+  logo               : 'doc/resources/adobe.png',
+  version            : System.getenv("PROJECT_VERSION") ?: "${versionMain}${versionQualifier}",
+  ownerUsername      : 'adobeinc',
+  ownerName          : 'Adobe Inc.',
+  ownerLogo          : 'doc/resources/adobe.png',
+  componentType      : 'sink',
+  tags               : ['"Adobe"', '"Kafka Connect"', '"Sink"'],
+  supportProviderName: 'Adobe Inc.',
+  supportUrl         : 'https://github.com/adobe/experience-platform-streaming-connect/issues',
+  supportLogo        : 'doc/resources/adobe.png',
+  supportSummary     : 'Please file issues, suggest changes or feature requests and question at  https://github.com/adobe/experience-platform-streaming-connect/issues'
+]
+
 subprojects {
   apply plugin: 'project-report'
   apply plugin: 'base'
@@ -48,7 +67,7 @@ subprojects {
   apply plugin: 'idea'
   apply plugin: 'jacoco'
 
-  version = System.getenv("PROJECT_VERSION") ?: "${versionMain}${versionQualifier}"
+  version = connectProperties.version
 
   checkstyle {
     configFile = rootProject.file('config/checkstyle/checkstyle.xml')
@@ -188,6 +207,91 @@ sonarqube {
   }
 }
 
+def basePackage = "build/package"
+
+task copyDependencies(type: Copy) {
+  from subprojects.configurations.default
+  into "$basePackage/lib"
+
+  from "streaming-connect-sink/build/libs/streaming-connect-sink-${connectProperties.version}.jar"
+  into "$basePackage/lib"
+
+  doLast {
+    delete fileTree('streaming-connect-sink/build/libs/') {
+      include "streaming-connect-sink-${connectProperties.version}.jar"
+    }
+    copy {
+      from projectDir.getAbsolutePath() + "/doc/resources/adobe.png"
+      into "$basePackage/assets"
+    }
+
+    copy {
+      from projectDir.getAbsolutePath() + "/LICENSE"
+      into "$basePackage/doc"
+    }
+
+    copy {
+      from projectDir.getAbsolutePath() + "/README.md"
+      into "$basePackage/doc"
+    }
+
+    new File(projectDir, "/$basePackage/manifest.json").text = """{
+  "component_types": [ "$connectProperties.componentType" ],
+  "description": "$connectProperties.description",
+  "docker_image": {
+    "tag": "$connectProperties.version",
+    "name": "$connectProperties.componentName",
+    "namespace": "",
+    "registry": ""
+  },
+  "documentation_url": "$connectProperties.documentationUrl",
+  "features": {
+    "confluent_control_center_integration": true,
+    "delivery_guarantee": [ "at_least_once"],
+    "kafka_connect_api": true,
+    "single_message_transforms": true,
+    "supported_encodings": [ "json" ]
+  },
+  "license": [
+    {
+      "name": "Apache License, Version 2.0",
+      "url": "http://www.apache.org/licenses/LICENSE-2.0",
+      "logo": "assets/apache_logo.gif"
+    }
+  ],
+  "logo": "$connectProperties.logo",
+  "name": "$connectProperties.componentName",
+  "owner": {
+    "logo": "$connectProperties.ownerLogo",
+    "name": "$connectProperties.ownerName",
+    "type": "organization",
+    "username": "$connectProperties.ownerUsername"
+  },
+  "requirements": [ "AEP Platform Account" ],
+  "support": {
+    "logo": "$connectProperties.supportLogo",
+    "provider_name": "$connectProperties.supportProviderName",
+    "summary": "$connectProperties.supportSummary",
+    "url": "$connectProperties.supportUrl"
+  },
+  "tags": $connectProperties.tags,
+  "title": "$connectProperties.title",
+  "version": "$connectProperties.version"
+}
+  """
+  }
+
+}
+
+task kafkaConnectPublish(type: Zip) {
+  dependsOn(copyDependencies)
+
+  archiveName "$connectProperties.ownerUsername-$connectProperties.componentName-$connectProperties.version" + ".zip"
+  from "$basePackage/"
+  include '*'
+  include '*/*'
+}
+
 configurations.all {
   exclude module: 'slf4j-log4j12'
 }

doc/resources/adobe.png

@@ -11,7 +11,7 @@
 ##
 
 group=com.adobe.platform.streaming
-versionMain=0.0.9
+versionMain=0.0.10
 versionQualifier=
 
 param_artifactory_user=