Skip to content

Commit 8086016

Browse files
authored
v0.3.0 (#126)
* npmignore more files and fix to the update versions script * Improved Releasing section
1 parent 8b196f1 commit 8086016

File tree

7 files changed

+38
-9
lines changed

7 files changed

+38
-9
lines changed

.npmignore

+7-1
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,10 @@ schemaregistry-examples
1010
build
1111
.github
1212
.vscode
13-
.semaphore
13+
.semaphore
14+
examples
15+
test
16+
e2e
17+
bench
18+
ci
19+
proto

CHANGELOG.md

+9
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
# confluent-kafka-javascript v0.3.0
2+
3+
v0.3.0 is a limited availability feature release. It is supported for all usage.
4+
5+
## Features
6+
7+
1. References librdkafka v2.6.0. Refer to the [librdkafka v2.6.0 release notes](https://github.com/confluentinc/librdkafka/releases/tag/v2.6.0) for more information.
8+
9+
110
# confluent-kafka-javascript v0.2.1
211

312
v0.2.1 is a limited availability release. It is supported for all usage.

CONTRIBUTING.md

+15-1
Original file line numberDiff line numberDiff line change
@@ -233,11 +233,25 @@ Steps to update:
233233
1. Increment the `version` in `package.json`. Change the version in `util.js` too.
234234
If it's needed to change librdkafka version, see the **Updating librdkafka version** section.
235235
236+
1. Run `npm run prepack` to verify package version.
237+
236238
1. Run `npm install` to update the `package-lock.json` file.
237239
238240
1. Create a PR and merge the above changes, and tag the merged commit with the new version. This should be the same string as `version` in `package.json`.
239241
240242
1. The CI will run on the tag, which will create the release artifacts in Semaphore CI.
241243
242244
1. Create a new GitHub release with the tag, and upload the release artifacts from Semaphore CI.
243-
The release title should be the same string as `version` in `package.json`.
245+
The release title should be the same string as `version` in `package.json`.
246+
247+
1. build schemaregistry project to prepare for the release:
248+
`(cd schemaregistry && npm run build)`
249+
250+
1. Clear any file that isn't ignored by `.npmignore`
251+
252+
1. In case it's a release candidate add `--tag rc` to the following commands,
253+
to avoid setting it as latest one
254+
255+
1. Publish Kafka client, with `--dry-run` first: `npm publish --dry-run --workspace=. --otp=<otp_here>`
256+
257+
1. Publish Schema Registry client, with `--dry-run` first: `npm publish --dry-run --workspace=schemaregistry --otp=<otp_here>`

ci/update-version.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ function getBranch(cb) {
8484
}
8585

8686
function getPackageVersion(tag, branch) {
87-
let baseVersion = `v${tag.major}.${tag.minor}.${tag.patch}`;
87+
let baseVersion = `${tag.major}.${tag.minor}.${tag.patch}`;
8888

8989

9090
// publish with a -devel suffix for EA and RC releases.

package-lock.json

+3-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@confluentinc/kafka-javascript",
3-
"version": "0.3.0-RC1",
3+
"version": "0.3.0",
44
"description": "Node.js bindings for librdkafka",
55
"librdkafka": "2.6.0",
66
"librdkafka_win": "2.6.0",
@@ -82,4 +82,4 @@
8282
"schemaregistry",
8383
"schemaregistry-examples"
8484
]
85-
}
85+
}

schemaregistry/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@confluentinc/schemaregistry",
3-
"version": "0.3.0-RC1",
3+
"version": "0.3.0",
44
"description": "Node.js client for Confluent Schema Registry",
55
"main": "dist/index.js",
66
"types": "dist/index.d.ts",

0 commit comments

Comments
 (0)