[Backport 8.13] Update changelog for 8.13 (#2164)

.buildkite/functions/cleanup.sh

@@ -2,7 +2,7 @@
 #
 # Shared cleanup routines between different steps
 #
-# Please source .ci/functions/imports.sh as a whole not just this file
+# Please source .buildkite/functions/imports.sh as a whole not just this file
 #
 # Version 1.0.0
 # - Initial version after refactor

.buildkite/functions/wait-for-container.sh

@@ -2,7 +2,7 @@
 #
 # Exposes a routine scripts can call to wait for a container if that container set up a health command
 #
-# Please source .ci/functions/imports.sh as a whole not just this file
+# Please source .buildkite/functions/imports.sh as a whole not just this file
 #
 # Version 1.0.1
 # - Initial version after refactor

.ci/make.sh → .buildkite/make.sh

@@ -3,7 +3,7 @@
 #
 # Build entry script for elasticsearch-js
 #
-# Must be called: ./.ci/make.sh <target> <params>
+# Must be called: ./.buildkite/make.sh <target> <params>
 #
 # Version: 1.1.0
 #
@@ -34,8 +34,8 @@ STACK_VERSION=$VERSION
 set -euo pipefail
 
 product="elastic/elasticsearch-js"
-output_folder=".ci/output"
-codegen_folder=".ci/output"
+output_folder=".buildkite/output"
+codegen_folder=".buildkite/output"
 OUTPUT_DIR="$repo/${output_folder}"
 NODE_JS_VERSION=18
 WORKFLOW=${WORKFLOW-staging}
@@ -131,7 +131,7 @@ esac
 echo -e "\033[34;1mINFO: building $product container\033[0m"
 
 docker build \
-  --file .ci/Dockerfile \
+  --file .buildkite/Dockerfile-make \
   --tag "$product" \
   --build-arg NODE_JS_VERSION="$NODE_JS_VERSION" \
   --build-arg "BUILDER_UID=$(id -u)" \
@@ -156,7 +156,7 @@ if [[ -z "${BUILDKITE+x}" ]] && [[ -z "${CI+x}" ]] && [[ -z "${GITHUB_ACTIONS+x}
     --rm \
     $product \
     /bin/bash -c "mkdir -p /usr/src/elastic-client-generator-js/output && \
-      node .ci/make.mjs --task $TASK ${TASK_ARGS[*]}"
+      node .buildkite/make.mjs --task $TASK ${TASK_ARGS[*]}"
 else
   echo -e "\033[34;1mINFO: Running in CI mode"
   docker run \
@@ -171,15 +171,15 @@ else
       git clone https://$CLIENTS_GITHUB_TOKEN@github.com/elastic/elastic-client-generator-js.git && \
       mkdir -p /usr/src/elastic-client-generator-js/output && \
       cd /usr/src/elasticsearch-js && \
-      node .ci/make.mjs --task $TASK ${TASK_ARGS[*]}"
+      node .buildkite/make.mjs --task $TASK ${TASK_ARGS[*]}"
 fi
 
 # ------------------------------------------------------- #
 # Post Command tasks & checks
 # ------------------------------------------------------- #
 
 if [[ "$CMD" == "assemble" ]]; then
-	if compgen -G ".ci/output/*" > /dev/null; then
+	if compgen -G ".buildkite/output/*" > /dev/null; then
 		echo -e "\033[32;1mTARGET: successfully assembled client v$VERSION\033[0m"
 	else
 		echo -e "\033[31;1mTARGET: assemble failed, empty workspace!\033[0m"

.buildkite/pull-requests.json

@@ -9,7 +9,6 @@
         "\\.md$",
         "\\.asciidoc$",
         "^docs\\/",
-        "^\\.ci\\/",
         "^scripts\\/",
         "^catalog-info\\.yaml$",
         "^test\\/unit\\/",

.github/workflows/nodejs.yml

@@ -17,7 +17,7 @@ jobs:
         with:
           filters: |
             src-only:
-              - '!(**/*.{md,asciidoc,txt}|*.{md,asciidoc,txt}|{docs,.ci,.buildkite,scripts}/**/*|catalog-info.yaml)'
+              - '!(**/*.{md,asciidoc,txt}|*.{md,asciidoc,txt}|{docs,.buildkite,scripts}/**/*|catalog-info.yaml)'
               - '.github/workflows/**'
 
   test:

.npmignore

@@ -64,7 +64,6 @@ test
 scripts
 
 # ci configuration
-.ci
 .travis.yml
 .buildkite
 certs

README.md

@@ -21,6 +21,25 @@ of the getting started documentation.
 Refer to the [Connecting section](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/getting-started-js.html#_connecting)
 of the getting started documentation.
 
+## Compatibility
+
+The Elasticsearch client is compatible with currently maintained JS versions.
+
+Language clients are forward compatible; meaning that clients support
+communicating with greater or equal minor versions of Elasticsearch without
+breaking. It does not mean that the client automatically supports new features
+of newer Elasticsearch versions; it is only possible after a release of a new
+client version. For example, a 8.12 client version won't automatically support
+the new features of the 8.13 version of Elasticsearch, the 8.13 client version
+is required for that. Elasticsearch language clients are only backwards
+compatible with default distributions and without guarantees made.
+
+| Elasticsearch Version | Elasticsearch-JS Branch  | Supported |
+| --------------------- | ------------------------ | --------- |
+| main                  | main                     |           |
+| 8.x                   | 8.x                      | 8.x       |
+| 7.x                   | 7.x                      | 7.17      |
+
 ## Usage
 
 * [Creating an index](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/getting-started-js.html#_creating_an_index)

docs/changelog.asciidoc

@@ -1,11 +1,53 @@
 [[changelog-client]]
 == Release notes
 
+[discrete]
+=== 8.13.0
+
+[discrete]
+==== Features
+
+[discrete]
+===== Support for Elasticsearch `v8.13.0`
+
+You can find all the API changes
+https://www.elastic.co/guide/en/elasticsearch/reference/8.13/release-notes-8.13.0.html[here].
+
+[discrete]
+==== Fixes
+
+[discrete]
+===== Ensure new connections inherit client's set defaults https://github.com/elastic/elasticsearch-js/pull/2159[#2159]
+
+When instantiating a client, any connection-related defaults (e.g. `requestTimeout`) set on that client instance would not be inherited by nodes if they were entered as strings rather than a `ConnectionOptions` object.
+
+[discrete]
+=== 8.12.2
+
+[discrete]
+==== Fixes
+
+[discrete]
+===== Upgrade transport to 8.4.1 https://github.com/elastic/elasticsearch-js/pull/2137[#2137]
+
+Upgrades `@elastic/transport` to 8.4.1 to resolve https://github.com/elastic/elastic-transport-js/pull/83[a bug] where arrays in error diagnostics were unintentionally transformed into objects.
+
+[discrete]
+=== 8.12.1
+
+[discrete]
+==== Fixes
+
+[discrete]
+===== Fix hang in bulk helper semaphore https://github.com/elastic/elasticsearch-js/pull/2027[#2027]
+
+The failing state could be reached when a server's response times are slower than flushInterval.
+
 [discrete]
 === 8.12.0
 
 [discrete]
-=== Features
+==== Features
 
 [discrete]
 ===== Support for Elasticsearch `v8.12.0`
@@ -17,7 +59,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/8.12/release-notes-8.12.
 === 8.11.0
 
 [discrete]
-=== Features
+==== Features
 
 [discrete]
 ===== Support for Elasticsearch `v8.11.0`
@@ -36,7 +78,7 @@ See <<redaction>> for more information.
 === 8.10.0
 
 [discrete]
-=== Features
+==== Features
 
 [discrete]
 ===== Support for Elasticsearch `v8.10.0`

docs/examples/bulk.asciidoc

@@ -36,27 +36,27 @@ async function run () {
     id: 1,
     text: 'If I fall, don\'t bring me back.',
     user: 'jon',
-    date: new Date()
+    time: new Date()
   }, {
     id: 2,
     text: 'Winter is coming',
     user: 'ned',
-    date: new Date()
+    time: new Date()
   }, {
     id: 3,
     text: 'A Lannister always pays his debts.',
     user: 'tyrion',
-    date: new Date()
+    time: new Date()
   }, {
     id: 4,
     text: 'I am the blood of the dragon.',
     user: 'daenerys',
-    date: new Date()
+    time: new Date()
   }, {
     id: 5, // change this value to a string to see the bulk response with errors
     text: 'A girl is Arya Stark of Winterfell. And I\'m going home.',
     user: 'arya',
-    date: new Date()
+    time: new Date()
   }]
 
   const operations = dataset.flatMap(doc => [{ index: { _index: 'tweets' } }, doc])

docs/installation.asciidoc

@@ -74,25 +74,36 @@ of `^7.10.0`).
 [[js-compatibility-matrix]]
 === Compatibility matrix
 
-Language clients are forward compatible; meaning that clients support communicating with greater or equal minor versions of Elasticsearch.
-Elasticsearch language clients are only backwards compatible with default distributions and without guarantees made.
+Language clients are forward compatible; meaning that clients support
+communicating with greater or equal minor versions of {es} without breaking. It
+does not mean that the client automatically supports new features of newer {es} 
+versions; it is only possible after a release of a new client version. For
+example, a 8.12 client version won't automatically support the new features of
+the 8.13 version of {es}, the 8.13 client version is required for that.
+{es} language clients are only backwards compatible with default distributions
+and without guarantees made.
 
-[%header,cols=2*]
+[%header,cols=3*]
 |===
 |{es} Version
 |Client Version
+|Supported
 
+|`8.x`
 |`8.x`
 |`8.x`
 
 |`7.x`
 |`7.x`
+|`7.17`
 
 |`6.x`
 |`6.x`
+|
 
 |`5.x`
 |`5.x`
+|
 |===