Skip to content

Commit 453d92d

Browse files
authored
Merge pull request #41 from cloudant-labs/prepare-0.100.2-release
Proposed 0.100.2-kafka-1.0.0 release
2 parents 3dcec1d + fe00664 commit 453d92d

File tree

4 files changed

+33
-30
lines changed

4 files changed

+33
-30
lines changed

CHANGES.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Unreleased
1+
# 0.100.2-kafka-1.0.0 (2018-04-13)
22

33
- [FIXED] Issue where multiple source connector configurations overlapped causing incorrect message
44
publication or duplication.

CONTRIBUTING.md

+26
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,29 @@ Please read the agreement and acknowledge it by ticking the appropriate box in t
1313
text, for example:
1414

1515
- [x] Tick to sign-off your agreement to the Developer Certificate of Origin (DCO) 1.1
16+
17+
## Building from Source
18+
19+
The project requires Java 8 to build from source. Execute the following command in the project directory:
20+
21+
```sh
22+
./gradlew clean assemble
23+
```
24+
25+
## Test execution
26+
27+
Junit tests are available in `src/test/java`.
28+
29+
To execute locally, please modify values in `src/test/resources`, including:
30+
31+
- log4j.properties (optional)
32+
- test.properties (required)
33+
34+
The settings in `test.properties` have to include Cloudant database credentials and Kafka topic details as above.
35+
At a minimum you will need to update the values of `cloudant.db.url` `cloudant.db.username` and `cloudant.db.password`.
36+
The Cloudant credentials must have `_admin` permission as the database referenced by `cloudant.db.url` will be
37+
created if it does not exist and will be deleted at the end of the tests.
38+
39+
```sh
40+
./gradlew test
41+
```

README.md

+5-28
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# Kafka Connect Cloudant
22

3+
[![Build Status](https://travis-ci.org/cloudant-labs/kafka-connect-cloudant.svg?branch=master)](https://travis-ci.org/cloudant-labs/kafka-connect-cloudant)
4+
[![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")
5+
36
Kafka Connect Cloudant Connector. This project includes source & sink connectors.
47

58
## Release Status
@@ -10,8 +13,6 @@ Experimental
1013

1114
* Configuration
1215
* Usage
13-
* Building from Source
14-
* Test execution
1516

1617
## Configuration
1718

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

7374
## Usage
7475

76+
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").
77+
7578
Kafka will use the $CLASSPATH to locate available connectors. Make sure to add the connector library to your $CLASSPATH first.
7679

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

110113
`log4j.logger.com.ibm.cloudant.kafka=DEBUG, stdout`
111-
112-
## Building from Source
113-
114-
The project requires Java 8 to build from source. Execute the following command in the project directory:
115-
116-
```sh
117-
./gradlew clean assemble
118-
```
119-
120-
## Test execution
121-
122-
Junit tests are available in `src/test/java`.
123-
124-
To execute locally, please modify values in `src/test/resources`, including:
125-
126-
- log4j.properties (optional)
127-
- test.properties (required)
128-
129-
The settings in `test.properties` have to include Cloudant database credentials and Kafka topic details as above.
130-
At a minimum you will need to update the values of `cloudant.db.url` `cloudant.db.username` and `cloudant.db.password`.
131-
The Cloudant credentials must have `_admin` permission as the database referenced by `cloudant.db.url` will be
132-
created if it does not exist and will be deleted at the end of the tests.
133-
134-
```sh
135-
./gradlew test
136-
```

VERSION

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
0.100.2-kafka-1.0.0-SNAPSHOT
1+
0.100.2-kafka-1.0.0

0 commit comments

Comments
 (0)