Skip to content

Commit

Permalink
Merge pull request #41 from cloudant-labs/prepare-0.100.2-release
Browse files Browse the repository at this point in the history
Proposed 0.100.2-kafka-1.0.0 release
  • Loading branch information
ricellis authored Apr 13, 2018
2 parents 3dcec1d + fe00664 commit 453d92d
Show file tree
Hide file tree
Showing 4 changed files with 33 additions and 30 deletions.
2 changes: 1 addition & 1 deletion CHANGES.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Unreleased
# 0.100.2-kafka-1.0.0 (2018-04-13)

- [FIXED] Issue where multiple source connector configurations overlapped causing incorrect message
publication or duplication.
Expand Down
26 changes: 26 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,29 @@ Please read the agreement and acknowledge it by ticking the appropriate box in t
text, for example:

- [x] Tick to sign-off your agreement to the Developer Certificate of Origin (DCO) 1.1

## Building from Source

The project requires Java 8 to build from source. Execute the following command in the project directory:

```sh
./gradlew clean assemble
```

## Test execution

Junit tests are available in `src/test/java`.

To execute locally, please modify values in `src/test/resources`, including:

- log4j.properties (optional)
- test.properties (required)

The settings in `test.properties` have to include Cloudant database credentials and Kafka topic details as above.
At a minimum you will need to update the values of `cloudant.db.url` `cloudant.db.username` and `cloudant.db.password`.
The Cloudant credentials must have `_admin` permission as the database referenced by `cloudant.db.url` will be
created if it does not exist and will be deleted at the end of the tests.

```sh
./gradlew test
```
33 changes: 5 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# Kafka Connect Cloudant

[![Build Status](https://travis-ci.org/cloudant-labs/kafka-connect-cloudant.svg?branch=master)](https://travis-ci.org/cloudant-labs/kafka-connect-cloudant)
[![Maven Central](https://img.shields.io/maven-central/v/com.cloudant/kafka-connect-cloudant.svg)](http://search.maven.org/#search|ga|1|g:"com.cloudant"%20AND%20a:"kafka-connect-cloudant")

Kafka Connect Cloudant Connector. This project includes source & sink connectors.

## Release Status
Expand All @@ -10,8 +13,6 @@ Experimental

* Configuration
* Usage
* Building from Source
* Test execution

## Configuration

Expand Down Expand Up @@ -72,6 +73,8 @@ replication|false|NO|false|Managed object schema in sink database <br>*true: dup

## Usage

The kafka-cloudant-connect jar is available to download from [Maven Central](http://search.maven.org/#search|ga|1|g:"com.cloudant"%20AND%20a:"kafka-connect-cloudant").

Kafka will use the $CLASSPATH to locate available connectors. Make sure to add the connector library to your $CLASSPATH first.

Connector execution in Kafka is available through scripts in the Kafka install path:
Expand Down Expand Up @@ -108,29 +111,3 @@ INFO level logging is configured by default to the console. To change log levels
and add log settings like

`log4j.logger.com.ibm.cloudant.kafka=DEBUG, stdout`

## Building from Source

The project requires Java 8 to build from source. Execute the following command in the project directory:

```sh
./gradlew clean assemble
```

## Test execution

Junit tests are available in `src/test/java`.

To execute locally, please modify values in `src/test/resources`, including:

- log4j.properties (optional)
- test.properties (required)

The settings in `test.properties` have to include Cloudant database credentials and Kafka topic details as above.
At a minimum you will need to update the values of `cloudant.db.url` `cloudant.db.username` and `cloudant.db.password`.
The Cloudant credentials must have `_admin` permission as the database referenced by `cloudant.db.url` will be
created if it does not exist and will be deleted at the end of the tests.

```sh
./gradlew test
```
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
0.100.2-kafka-1.0.0-SNAPSHOT
0.100.2-kafka-1.0.0

0 comments on commit 453d92d

Please sign in to comment.