From 14873e860674fdc75e3e23303e91d0b203a402bf Mon Sep 17 00:00:00 2001 From: Emanuele Sabellico Date: Thu, 17 Oct 2024 14:29:55 +0200 Subject: [PATCH 1/6] npmignore more files and fix to the update versions script --- .npmignore | 8 +++++++- ci/update-version.js | 2 +- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/.npmignore b/.npmignore index 418ac7aa..4ab27c1d 100644 --- a/.npmignore +++ b/.npmignore @@ -10,4 +10,10 @@ schemaregistry-examples build .github .vscode -.semaphore \ No newline at end of file +.semaphore +examples +test +e2e +bench +ci +proto \ No newline at end of file diff --git a/ci/update-version.js b/ci/update-version.js index 50957b74..531ed2ef 100644 --- a/ci/update-version.js +++ b/ci/update-version.js @@ -84,7 +84,7 @@ function getBranch(cb) { } function getPackageVersion(tag, branch) { - let baseVersion = `v${tag.major}.${tag.minor}.${tag.patch}`; + let baseVersion = `${tag.major}.${tag.minor}.${tag.patch}`; // publish with a -devel suffix for EA and RC releases. From 6f5b81ab00e789c59dccf0b960b76079f43d7e2a Mon Sep 17 00:00:00 2001 From: Emanuele Sabellico Date: Thu, 17 Oct 2024 14:30:07 +0200 Subject: [PATCH 2/6] 0.3.0 --- package-lock.json | 6 +++--- package.json | 4 ++-- schemaregistry/package.json | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/package-lock.json b/package-lock.json index dac3047c..94a54ede 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@confluentinc/kafka-javascript", - "version": "0.3.0-RC1", + "version": "0.3.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@confluentinc/kafka-javascript", - "version": "0.3.0-RC1", + "version": "0.3.0", "hasInstallScript": true, "license": "MIT", "workspaces": [ @@ -9297,7 +9297,7 @@ }, "schemaregistry": { "name": "@confluentinc/schemaregistry", - "version": "0.3.0-RC1", + "version": "0.3.0", "license": "MIT", "dependencies": { "@aws-sdk/client-kms": "^3.637.0", diff --git a/package.json b/package.json index d8c00ad5..67355985 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@confluentinc/kafka-javascript", - "version": "0.3.0-RC1", + "version": "0.3.0", "description": "Node.js bindings for librdkafka", "librdkafka": "2.6.0", "librdkafka_win": "2.6.0", @@ -82,4 +82,4 @@ "schemaregistry", "schemaregistry-examples" ] -} +} \ No newline at end of file diff --git a/schemaregistry/package.json b/schemaregistry/package.json index d375087b..88a03771 100644 --- a/schemaregistry/package.json +++ b/schemaregistry/package.json @@ -1,6 +1,6 @@ { "name": "@confluentinc/schemaregistry", - "version": "0.3.0-RC1", + "version": "0.3.0", "description": "Node.js client for Confluent Schema Registry", "main": "dist/index.js", "types": "dist/index.d.ts", From 1a416371744e6d6650e3195254f79abcd64bf023 Mon Sep 17 00:00:00 2001 From: Emanuele Sabellico Date: Thu, 17 Oct 2024 14:41:37 +0200 Subject: [PATCH 3/6] Improved Releasing section --- CONTRIBUTING.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d35f8f19..ff58dba2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -240,4 +240,16 @@ If it's needed to change librdkafka version, see the **Updating librdkafka versi 1. The CI will run on the tag, which will create the release artifacts in Semaphore CI. 1. Create a new GitHub release with the tag, and upload the release artifacts from Semaphore CI. - The release title should be the same string as `version` in `package.json`. \ No newline at end of file + The release title should be the same string as `version` in `package.json`. + +1. build schemaregistry project to prepare for the release: + `(cd schemaregistry && npm run build)` + +1. Clear any file that isn't ignored by `.npmignore` + +1. In case it's a release candidate add `--tag rc` to the following commands, + to avoid setting it as latest one + +1. Publish Kafka client `npm publish --workspace=. --otp=` + +1. Publish Schema Registry client `npm publish --workspace=schemaregistry --otp=` \ No newline at end of file From 6fb32c8dca80a0138da3c336fecc38c94e2bd058 Mon Sep 17 00:00:00 2001 From: Emanuele Sabellico Date: Thu, 17 Oct 2024 14:41:49 +0200 Subject: [PATCH 4/6] Changelog entry --- CHANGELOG.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 11802730..bf259606 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,12 @@ +# confluent-kafka-javascript v0.3.0 + +v0.3.0 is a limited availability feature release. It is supported for all usage. + +## Features + +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. + + # confluent-kafka-javascript v0.2.1 v0.2.1 is a limited availability release. It is supported for all usage. From 036450a8b023614cdd53355f300242a3b97679b8 Mon Sep 17 00:00:00 2001 From: Emanuele Sabellico Date: Thu, 17 Oct 2024 14:45:45 +0200 Subject: [PATCH 5/6] Improved Release section --- CONTRIBUTING.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ff58dba2..ef37cc13 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -233,6 +233,8 @@ Steps to update: 1. Increment the `version` in `package.json`. Change the version in `util.js` too. If it's needed to change librdkafka version, see the **Updating librdkafka version** section. +1. Run `npm run prepack` to verify package version. + 1. Run `npm install` to update the `package-lock.json` file. 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`. From c3e03687d783d06d5af79f05e98df886302b5bb9 Mon Sep 17 00:00:00 2001 From: Emanuele Sabellico Date: Thu, 17 Oct 2024 14:50:23 +0200 Subject: [PATCH 6/6] Mention running with dry-run --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ef37cc13..c4e807a4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -252,6 +252,6 @@ If it's needed to change librdkafka version, see the **Updating librdkafka versi 1. In case it's a release candidate add `--tag rc` to the following commands, to avoid setting it as latest one -1. Publish Kafka client `npm publish --workspace=. --otp=` +1. Publish Kafka client, with `--dry-run` first: `npm publish --dry-run --workspace=. --otp=` -1. Publish Schema Registry client `npm publish --workspace=schemaregistry --otp=` \ No newline at end of file +1. Publish Schema Registry client, with `--dry-run` first: `npm publish --dry-run --workspace=schemaregistry --otp=` \ No newline at end of file