diff --git a/README.md b/README.md index fd6320c..5ceafe5 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ Kafka Connect ArangoDB is a Kafka Connector that translates record data into `RE Requires ArangoDB 3.4 or higher. -A full example of how Kafka Connect ArangoDB can be integrated into a Kafka cluster is available in the [development documentation](docs/development/). +A full example of how Kafka Connect ArangoDB can be integrated into a Kafka cluster is available in the [development documentation](/docs/development/). ### Record Formats and Structures The following record formats are supported: diff --git a/config/quickstart-kafka-connect-arangodb-sink.properties b/config/quickstart-kafka-connect-arangodb-sink.properties index 7ea6494..731c7e6 100644 --- a/config/quickstart-kafka-connect-arangodb-sink.properties +++ b/config/quickstart-kafka-connect-arangodb-sink.properties @@ -3,7 +3,7 @@ name=arangodb-sink connector.class=com.mentor.kafka.kafkaconnectarangodb.sink.ArangoDBSinkConector tasks.max=1 -# The topics to consume from (comma-separated for a list of multiple topics) +# Topics to consume from (comma-separated for a list of multiple topics) topics=stream.airports,stream.flights # ArangoDB sink configuration @@ -15,4 +15,4 @@ arangodb.database.name=kafka-connect-arangodb # Optional transformers transforms=cdc -transforms.cdc.type=com.mentor.kafka.kafkaconnectarangodb.sink.transforms.CDC +transforms.cdc.type=io.github.jaredpetersen.kafkaconnectarangodb.sink.transforms.Cdc diff --git a/docs/development/README.md b/docs/development/README.md index 8ff5043..641fa05 100644 --- a/docs/development/README.md +++ b/docs/development/README.md @@ -65,7 +65,5 @@ Assuming the application has already been compiled and packaged via `mvn clean p 7. Clean up all containers and created volumes when you're done. ```bash - docker stop $(docker ps -aq) - docker rm $(docker ps -aq) - docker volume prune + docker-compose down -v ``` diff --git a/docs/development/connect/Dockerfile b/docs/development/connect/Dockerfile index 67f28ea..8a92732 100644 --- a/docs/development/connect/Dockerfile +++ b/docs/development/connect/Dockerfile @@ -3,7 +3,6 @@ FROM confluentinc/cp-kafka-connect-base:${VERSION} ENV CONNECT_PLUGINS_DIR /usr/share/java/kafka-connect -# Create Plugin Directory RUN mkdir ${CONNECT_PLUGINS_DIR} # Install Kafka Connect ArangoDB diff --git a/docs/release/README.md b/docs/release/README.md new file mode 100644 index 0000000..f1e0cee --- /dev/null +++ b/docs/release/README.md @@ -0,0 +1,34 @@ +# Release +Only [@jaredpetersen](https://github.com/jaredpetersen) is able to deploy a new release of Kafka Connect ArangoDB. Always deploy a new version to Maven Central and Confluent Hub. + +## GitHub +1. Ensure that Kafka Connect ArangoDB's version was revised in the last merge to the master branch. +2. Go to the [Releases section](https://github.com/jaredpetersen/kafka-connect-arangodb/releases) of the repository on GitHub. +3. Draft a new release +4. Fill the tag version input box with the new release version. +5. Fill the release title input box with the new release version. +6. Fill in the release description input bux with the recent changes using the [Keep a Changelog standard](https://keepachangelog.com/en/1.0.0/). +7. Click the Publish release button. + +## Maven Central +1. Ensure that Kafka Connect ArangoDB's version was revised in the last merge to the master branch. +2. Deploy the plugin to Maven Central for staging. + ``` + mvn clean deploy -Pdeploy + ``` +3. Log in to the [repository manager](https://oss.sonatype.org/) for Maven Central. +4. Navigate to [Staging Repositories](https://oss.sonatype.org/#stagingRepositories) and locate the staged release in the listings. +5. Click on the staged release and navigate to the Content tab. +6. Confirm that the content is correct. As an additional measure, you can download the published jar and confirm that the JAR works in the [local development cluster](/docs/development). +7. If the content is correct, close the release by clicking the Close button at the top. +8. The repository manager will begin evaluating the releasability of the plugin against the [Maven Central requirements](https://central.sonatype.org/pages/requirements.html). Assuming that everything is good to go, release the plugin by clicking the Release button at the top. +9. Drop the staged repository by clicking the Drop button at the top. +10. Wait at least an hour and [confirm that the plugin has been updated](https://search.maven.org/search?q=g:io.github.jaredpetersen%20AND%20a:kafka-connect-arangodb&core=gav). + +## Confluent Hub +1. Ensure that Kafka Connect ArangoDB's version was revised in the last merge to the master branch. +2. Package the plugin in Confluent Hub's archive format. + ``` + mvn clean package + ``` +3. Send an email to [confluent-hub@confluent.io](mailto:confluent-hub@confluent.io?Subject=Kafka%20Connect%20ArangoDB%20Plugin%20--%20New%20Version%20Submission) attached with the compressed component archive located at `/target/components/packages`. If the component archive is too large, upload it to a cloud storage provider and provide the link. \ No newline at end of file diff --git a/pom.xml b/pom.xml index 065c037..7f93803 100644 --- a/pom.xml +++ b/pom.xml @@ -5,7 +5,7 @@ io.github.jaredpetersen kafka-connect-arangodb - 1.0.3 + 1.0.4 jar kafka-connect-arangodb @@ -61,7 +61,6 @@ 2.9.8 5.3.2 2.23.4 - 0.11.1 @@ -83,7 +82,7 @@ com.puppycrawl.tools checkstyle - 8.16 + 8.18 @@ -131,7 +130,7 @@ org.jacoco jacoco-maven-plugin - 0.8.2 + 0.8.3 **/ArangoDbSinkTask.* @@ -183,7 +182,7 @@ io.confluent kafka-connect-maven-plugin - ${confluent.connect.plugin.version} + 0.11.1 package @@ -264,7 +263,7 @@ org.apache.maven.plugins maven-javadoc-plugin - 3.0.1 + 3.1.0 attach-javadocs @@ -273,6 +272,9 @@ + + ${java.version} + diff --git a/src/test/java/io/github/jaredpetersen/kafkaconnectarangodb/sink/ArangoDbSinkConnectorTests.java b/src/test/java/io/github/jaredpetersen/kafkaconnectarangodb/sink/ArangoDbSinkConnectorTests.java index 0010275..712c491 100644 --- a/src/test/java/io/github/jaredpetersen/kafkaconnectarangodb/sink/ArangoDbSinkConnectorTests.java +++ b/src/test/java/io/github/jaredpetersen/kafkaconnectarangodb/sink/ArangoDbSinkConnectorTests.java @@ -15,7 +15,7 @@ public class ArangoDbSinkConnectorTests { @Test public void versionReturnsVersion() { final SinkConnector connector = new ArangoDbSinkConnector(); - assertEquals("1.0.3", connector.version()); + assertEquals("1.0.4", connector.version()); } @Test diff --git a/src/test/java/io/github/jaredpetersen/kafkaconnectarangodb/sink/ArangoDbSinkTaskTests.java b/src/test/java/io/github/jaredpetersen/kafkaconnectarangodb/sink/ArangoDbSinkTaskTests.java index 0470b24..0eeb184 100644 --- a/src/test/java/io/github/jaredpetersen/kafkaconnectarangodb/sink/ArangoDbSinkTaskTests.java +++ b/src/test/java/io/github/jaredpetersen/kafkaconnectarangodb/sink/ArangoDbSinkTaskTests.java @@ -9,7 +9,7 @@ public class ArangoDbSinkTaskTests { @Test public void versionReturnsVersion() { final SinkTask task = new ArangoDbSinkTask(); - assertEquals("1.0.3", task.version()); + assertEquals("1.0.4", task.version()); } @Test diff --git a/src/test/java/io/github/jaredpetersen/kafkaconnectarangodb/util/PropertiesLoaderTests.java b/src/test/java/io/github/jaredpetersen/kafkaconnectarangodb/util/PropertiesLoaderTests.java index 80f002e..66448ce 100644 --- a/src/test/java/io/github/jaredpetersen/kafkaconnectarangodb/util/PropertiesLoaderTests.java +++ b/src/test/java/io/github/jaredpetersen/kafkaconnectarangodb/util/PropertiesLoaderTests.java @@ -15,6 +15,6 @@ public void constructorDoesNothing() { public void loadLoadsProperties() { final Properties properties = PropertiesLoader.load(); - assertEquals("1.0.3", properties.get("version")); + assertEquals("1.0.4", properties.get("version")); } }