Skip to content

Commit e3bb095

Browse files
authored
Change repo maintainer and package name (#1)
1 parent f88a7b1 commit e3bb095

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

76 files changed

+198
-202
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,15 @@ about: Create a report to help us improve
55
---
66

77
**Environment Information**
8-
- OS [e.g. Mac, Arch, Windows 10]:
8+
- OS [e.g. Mac, Arch, Windows 10]:
99
- Node Version [e.g. 8.2.1]:
1010
- NPM Version [e.g. 5.4.2]:
1111
- C++ Toolchain [e.g. Visual Studio, llvm, g++]:
12-
- node-rdkafka version [e.g. 2.3.3]:
12+
- confluent-kafka-js version [e.g. 2.3.3]:
1313

1414
**Steps to Reproduce**
1515

16-
**node-rdkafka Configuration Settings**
16+
**confluent-kafka-js Configuration Settings**
1717

1818

1919
**Additional context**

.github/workflows/npm-publish.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
22
# For more information see: https://help.github.com/actions/language-and-framework-guides/publishing-nodejs-packages
33

4-
name: Publish node-rdkafka
4+
name: Publish confluent-kafka-js
55

66
on:
77
release:

CONTRIBUTING.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# Contributing to `node-rdkafka`
1+
# Contributing to `confluent-kafka-js`
22

33
:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:
44

5-
The following is a set of guidelines for contributing to `node-rdkafka`
6-
which is hosted in the [Blizzard Organization](https://github.com/blizzard)
5+
The following is a set of guidelines for contributing to `confluent-kafka-js`
6+
which is hosted by [Confluent Inc.](https://github.com/confluentinc)
77
on GitHub. This document lists rules, guidelines, and help getting started,
88
so if you feel something is missing feel free to send a pull request.
99

@@ -144,7 +144,7 @@ In short:
144144

145145
## Editor
146146

147-
I began using Visual Studio code to develop on `node-rdkafka`. If you use it you can configure the C++ plugin to resolve the paths needed to inform your intellisense. This is the config file I am using on a mac to resolve the required paths:
147+
Using Visual Studio code to develop on `confluent-kafka-js`. If you use it you can configure the C++ plugin to resolve the paths needed to inform your intellisense. This is the config file I am using on a mac to resolve the required paths:
148148

149149
`c_cpp_properties.json`
150150
```
@@ -198,7 +198,7 @@ You can add breakpoints and so on after that.
198198
The librdkafka should be periodically updated to the latest release in https://github.com/edenhill/librdkafka/releases
199199

200200
Steps to update:
201-
1. Update the `librdkafka` property in [`package.json`](https://github.com/Blizzard/node-rdkafka/blob/master/package.json) to the desired version.
201+
1. Update the `librdkafka` property in [`package.json`](https://github.com/confluentinc/confluent-kafka-js/blob/master/package.json) to the desired version.
202202

203203
1. Update the librdkafka git submodule to that versions release commit (example below)
204204

@@ -209,7 +209,7 @@ Steps to update:
209209

210210
If you get an error during that checkout command, double check that the submodule was initialized / cloned! You may need to run `git submodule update --init --recursive`
211211

212-
1. Update [`config.d.ts`](https://github.com/Blizzard/node-rdkafka/blob/master/config.d.ts) and [`errors.d.ts`](https://github.com/Blizzard/node-rdkafka/blob/master/errors.d.ts) TypeScript definitions by running:
212+
1. Update [`config.d.ts`](https://github.com/confluentinc/confluent-kafka-js/blob/master/config.d.ts) and [`errors.d.ts`](https://github.com/confluentinc/confluent-kafka-js/blob/master/errors.d.ts) TypeScript definitions by running:
213213
```bash
214214
node ci/librdkafka-defs-generator.js
215215
```
@@ -219,7 +219,7 @@ Steps to update:
219219
220220
1. Run unit tests: `npm run test`
221221
222-
1. Update the version numbers referenced in the [`README.md`](https://github.com/Blizzard/node-rdkafka/blob/master/README.md) file to the new version.
222+
1. Update the version numbers referenced in the [`README.md`](https://github.com/confluentinc/confluent-kafka-js/blob/master/README.md) file to the new version.
223223
224224
## Publishing new npm version
225225

LICENSE.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
The MIT License (MIT)
2-
Copyright (c) 2016 Blizzard Entertainment
2+
Copyright (c) 2016-2023 Blizzard Entertainment
33

44
Permission is hereby granted, free of charge, to any person obtaining a copy of
55
this software and associated documentation files (the "Software"), to deal in

README.md

Lines changed: 19 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,27 @@
1-
node-rdkafka - Node.js wrapper for Kafka C/C++ library
1+
confluent-kafka-js - Node.js wrapper for Kafka C/C++ library
22
==============================================
33

4-
Copyright (c) 2016 Blizzard Entertainment.
4+
Copyright (c) 2016-2023 Blizzard Entertainment.
55

6-
[https://github.com/blizzard/node-rdkafka](https://github.com/blizzard/node-rdkafka)
7-
8-
[![Build Status](https://github.com/Blizzard/node-rdkafka/actions/workflows/test.yml/badge.svg)](https://github.com/Blizzard/node-rdkafka/actions/workflows/test.yml)
9-
10-
[![npm version](https://badge.fury.io/js/node-rdkafka.svg)](https://badge.fury.io/js/node-rdkafka)
6+
[https://github.com/confluentinc/confluent-kafka-js](https://github.com/confluentinc/confluent-kafka-js)
117

128
# Looking for Collaborators!
139

14-
I am looking for *your* help to make this project even better! If you're interested, check [this out](https://github.com/Blizzard/node-rdkafka/issues/628)
10+
I am looking for *your* help to make this project even better! If you're interested, check [this out](https://github.com/confluentinc/confluent-kafka-js/issues/628)
1511

1612
# Overview
1713

18-
The `node-rdkafka` library is a high-performance NodeJS client for [Apache Kafka](http://kafka.apache.org/) that wraps the native [librdkafka](https://github.com/edenhill/librdkafka) library. All the complexity of balancing writes across partitions and managing (possibly ever-changing) brokers should be encapsulated in the library.
14+
The `confluent-kafka-js` library is a high-performance NodeJS client for [Apache Kafka](http://kafka.apache.org/) that wraps the native [librdkafka](https://github.com/edenhill/librdkafka) library. All the complexity of balancing writes across partitions and managing (possibly ever-changing) brokers should be encapsulated in the library.
1915

2016
__This library currently uses `librdkafka` version `2.3.0`.__
2117

2218
## Reference Docs
2319

24-
To view the reference docs for the current version, go [here](https://blizzard.github.io/node-rdkafka/current/)
20+
To view the reference docs for the current version, go [here](https://confluentinc.github.io/confluent-kafka-js/current/)
2521

2622
## Contributing
2723

28-
For guidelines on contributing please see [CONTRIBUTING.md](https://github.com/blizzard/node-rdkafka/blob/master/CONTRIBUTING.md)
24+
For guidelines on contributing please see [CONTRIBUTING.md](https://github.com/confluentinc/confluent-kafka-js/blob/master/CONTRIBUTING.md)
2925

3026
## Code of Conduct
3127

@@ -41,7 +37,7 @@ Play nice; Play fair.
4137

4238
### Mac OS High Sierra / Mojave
4339

44-
OpenSSL has been upgraded in High Sierra and homebrew does not overwrite default system libraries. That means when building node-rdkafka, because you are using openssl, you need to tell the linker where to find it:
40+
OpenSSL has been upgraded in High Sierra and homebrew does not overwrite default system libraries. That means when building confluent-kafka-js, because you are using openssl, you need to tell the linker where to find it:
4541

4642
```sh
4743
export CPPFLAGS=-I/usr/local/opt/openssl/include
@@ -56,7 +52,7 @@ __NOTE:__ From the `librdkafka` docs
5652
5753
### Alpine
5854

59-
Using Alpine Linux? Check out the [docs](https://github.com/Blizzard/node-rdkafka/blob/master/examples/docker-alpine.md).
55+
Using Alpine Linux? Check out the [docs](https://github.com/confluentinc/confluent-kafka-js/blob/master/examples/docker-alpine.md).
6056

6157
### Windows
6258

@@ -65,7 +61,7 @@ Windows build **is not** compiled from `librdkafka` source but it is rather link
6561
Requirements:
6662
* [node-gyp for Windows](https://github.com/nodejs/node-gyp#on-windows)
6763

68-
**Note:** I _still_ do not recommend using `node-rdkafka` in production on Windows. This feature was in high demand and is provided to help develop, but we do not test against Windows, and windows support may lag behind Linux/Mac support because those platforms are the ones used to develop this library. Contributors are welcome if any Windows issues are found :)
64+
**Note:** I _still_ do not recommend using `confluent-kafka-js` in production on Windows. This feature was in high demand and is provided to help develop, but we do not test against Windows, and windows support may lag behind Linux/Mac support because those platforms are the ones used to develop this library. Contributors are welcome if any Windows issues are found :)
6965

7066
## Tests
7167

@@ -83,16 +79,16 @@ You can run both types of tests by using `Makefile`. Doing so calls `mocha` in y
8379

8480
# Usage
8581

86-
You can install the `node-rdkafka` module like any other module:
82+
You can install the `confluent-kafka-js` module like any other module:
8783

8884
```
89-
npm install node-rdkafka
85+
npm install confluent-kafka-js
9086
```
9187

9288
To use the module, you must `require` it.
9389

9490
```js
95-
const Kafka = require('node-rdkafka');
91+
const Kafka = require('confluent-kafka-js');
9692
```
9793

9894
## Configuration
@@ -117,10 +113,10 @@ The library currently supports the following callbacks:
117113

118114
This library includes two utility functions for detecting the status of your installation. Please try to include these when making issue reports where applicable.
119115

120-
You can get the features supported by your compile of `librdkafka` by reading the variable "features" on the root of the `node-rdkafka` object.
116+
You can get the features supported by your compile of `librdkafka` by reading the variable "features" on the root of the `confluent-kafka-js` object.
121117

122118
```js
123-
const Kafka = require('node-rdkafka');
119+
const Kafka = require('confluent-kafka-js');
124120
console.log(Kafka.features);
125121

126122
// #=> [ 'gzip', 'snappy', 'ssl', 'sasl', 'regex', 'lz4' ]
@@ -129,7 +125,7 @@ console.log(Kafka.features);
129125
You can also get the version of `librdkafka`
130126

131127
```js
132-
const Kafka = require('node-rdkafka');
128+
const Kafka = require('confluent-kafka-js');
133129
console.log(Kafka.librdkafkaVersion);
134130

135131
// #=> 2.3.0
@@ -382,7 +378,7 @@ const consumer = new Kafka.KafkaConsumer({
382378

383379
### Commits
384380

385-
When you commit in `node-rdkafka`, the standard way is to queue the commit request up with the next `librdkafka` request to the broker. When doing this, there isn't a way to know the result of the commit. Luckily there is another callback you can listen to to get this information
381+
When you commit in `confluent-kafka-js`, the standard way is to queue the commit request up with the next `librdkafka` request to the broker. When doing this, there isn't a way to know the result of the commit. Luckily there is another callback you can listen to to get this information
386382

387383
```js
388384
const consumer = new Kafka.KafkaConsumer({
@@ -596,12 +592,12 @@ producer.getMetadata(opts, (err, metadata) => {
596592

597593
## Admin Client
598594

599-
`node-rdkafka` now supports the admin client for creating, deleting, and scaling out topics. The `librdkafka` APIs also support altering configuration of topics and broker, but that is not currently implemented.
595+
`confluent-kafka-js` now supports the admin client for creating, deleting, and scaling out topics. The `librdkafka` APIs also support altering configuration of topics and broker, but that is not currently implemented.
600596

601597
To create an Admin client, you can do as follows:
602598

603599
```js
604-
const Kafka = require('node-rdkafka');
600+
const Kafka = require('confluent-kafka-js');
605601

606602
const client = Kafka.AdminClient.create({
607603
'client.id': 'kafka-admin',

bench/consumer-raw-rdkafka.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*
2-
* node-rdkafka - Node.js wrapper for RdKafka C/C++ library
2+
* confluent-kafka-js - Node.js wrapper for RdKafka C/C++ library
33
*
4-
* Copyright (c) 2016 Blizzard Entertainment
4+
* Copyright (c) 2016-2023 Blizzard Entertainment
55
*
66
* This software may be modified and distributed under the terms
77
* of the MIT license. See the LICENSE.txt file for details.
@@ -16,7 +16,7 @@ var topic = process.argv[3] || 'test';
1616

1717
var consumer = new Kafka.KafkaConsumer({
1818
'metadata.broker.list': host,
19-
'group.id': 'node-rdkafka-bench-s',
19+
'group.id': 'confluent-kafka-js-bench-s',
2020
'fetch.wait.max.ms': 100,
2121
'fetch.message.max.bytes': 1024 * 1024,
2222
'enable.auto.commit': false

bench/consumer-subscribe.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*
2-
* node-rdkafka - Node.js wrapper for RdKafka C/C++ library
2+
* confluent-kafka-js - Node.js wrapper for RdKafka C/C++ library
33
*
4-
* Copyright (c) 2016 Blizzard Entertainment
4+
* Copyright (c) 2016-2023 Blizzard Entertainment
55
*
66
* This software may be modified and distributed under the terms
77
* of the MIT license. See the LICENSE.txt file for details.
@@ -16,7 +16,7 @@ var topic = process.argv[3] || 'test';
1616

1717
var consumer = new Kafka.KafkaConsumer({
1818
'metadata.broker.list': host,
19-
'group.id': 'node-rdkafka-bench',
19+
'group.id': 'confluent-kafka-js-bench',
2020
'fetch.wait.max.ms': 100,
2121
'fetch.message.max.bytes': 1024 * 1024,
2222
'enable.auto.commit': false

bench/kafka-consumer-stream.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*
2-
* node-rdkafka - Node.js wrapper for RdKafka C/C++ library
2+
* confluent-kafka-js - Node.js wrapper for RdKafka C/C++ library
33
*
4-
* Copyright (c) 2016 Blizzard Entertainment
4+
* Copyright (c) 2016-2023 Blizzard Entertainment
55
*
66
* This software may be modified and distributed under the terms
77
* of the MIT license. See the LICENSE.txt file for details.
@@ -18,7 +18,7 @@ var topic = process.argv[3] || 'test';
1818

1919
var stream = Kafka.createReadStream({
2020
'metadata.broker.list': host,
21-
'group.id': 'node-rdkafka-benchs',
21+
'group.id': 'confluent-kafka-js-benchs',
2222
'fetch.wait.max.ms': 100,
2323
'fetch.message.max.bytes': 1024 * 1024,
2424
'enable.auto.commit': false

bench/producer-raw-rdkafka.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*
2-
* node-rdkafka - Node.js wrapper for RdKafka C/C++ library
2+
* confluent-kafka-js - Node.js wrapper for RdKafka C/C++ library
33
*
4-
* Copyright (c) 2016 Blizzard Entertainment
4+
* Copyright (c) 2016-2023 Blizzard Entertainment
55
*
66
* This software may be modified and distributed under the terms
77
* of the MIT license. See the LICENSE.txt file for details.
@@ -24,7 +24,7 @@ var MAX = process.argv[5] || 10000000;
2424

2525
var producer = new Kafka.Producer({
2626
'metadata.broker.list': host,
27-
'group.id': 'node-rdkafka-bench',
27+
'group.id': 'confluent-kafka-js-bench',
2828
'compression.codec': compression,
2929
'retry.backoff.ms': 200,
3030
'message.send.max.retries': 10,

bench/producer-rdkafka.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*
2-
* node-rdkafka - Node.js wrapper for RdKafka C/C++ library
2+
* confluent-kafka-js - Node.js wrapper for RdKafka C/C++ library
33
*
4-
* Copyright (c) 2016 Blizzard Entertainment
4+
* Copyright (c) 2016-2023 Blizzard Entertainment
55
*
66
* This software may be modified and distributed under the terms
77
* of the MIT license. See the LICENSE.txt file for details.
@@ -20,7 +20,7 @@ var MAX = process.argv[5] || 1000000;
2020

2121
var stream = Kafka.Producer.createWriteStream({
2222
'metadata.broker.list': host,
23-
'group.id': 'node-rdkafka-bench',
23+
'group.id': 'confluent-kafka-js-bench',
2424
'compression.codec': compression,
2525
'retry.backoff.ms': 200,
2626
'message.send.max.retries': 10,

0 commit comments

Comments
 (0)