From b3ad1889edd367689445e03602738af6f56156bf Mon Sep 17 00:00:00 2001 From: Daniel Dyla Date: Thu, 30 Apr 2020 09:22:31 -0400 Subject: [PATCH 1/2] chore: test on node 14 --- .circleci/config.yml | 6 +++--- README.md | 8 ++++++++ 2 files changed, 11 insertions(+), 3 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index 3764a844a5..350ee4946b 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -184,9 +184,9 @@ jobs: - image: node:12 environment: *node_test_env <<: *node_unit_tests - node13: + node14: docker: - - image: node:13 + - image: node:14 environment: *node_test_env <<: *node_unit_tests node12-browsers: @@ -213,6 +213,6 @@ workflows: - node8 - node10 - node12 - - node13 + - node14 - node12-browsers diff --git a/README.md b/README.md index d330f48244..410729ecb9 100644 --- a/README.md +++ b/README.md @@ -54,6 +54,14 @@ To get started tracing your own application, see the [Getting Started Guide](get If you are a library author looking to build OpenTelemetry into your library, please see [the documentation][docs]. As a library author, it is important that you only depend on properties and methods published on the public API. If you use any properties or methods from the SDK that are not officially a part of the public API, your library may break if an [Application Owner](#application-owner) uses a different SDK implementation. +## Supported Runtimes + +Node.js v10 and greater is officially supported, but the tests are also run against the latest release of Node.js v8. +Note that versions of Node.js older than 8.5.0 are known to not work. + +Browser tests are run in Chrome. +There is currently no list of officially supported browsers, but OpenTelemetry should work in supported versions of major browsers. + ## Release Schedule OpenTelemetry JS is under active development. From a07f6ee3d14c627399007fadd2534499cc355365 Mon Sep 17 00:00:00 2001 From: Daniel Dyla Date: Fri, 1 May 2020 16:05:13 -0400 Subject: [PATCH 2/2] chore: clarify wording and add support table --- README.md | 21 ++++++++++++++++----- 1 file changed, 16 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 410729ecb9..6a1eee3042 100644 --- a/README.md +++ b/README.md @@ -56,11 +56,22 @@ If you are a library author looking to build OpenTelemetry into your library, pl ## Supported Runtimes -Node.js v10 and greater is officially supported, but the tests are also run against the latest release of Node.js v8. -Note that versions of Node.js older than 8.5.0 are known to not work. - -Browser tests are run in Chrome. -There is currently no list of officially supported browsers, but OpenTelemetry should work in supported versions of major browsers. +Platform Version | Supported +---------------- | --------- +Node.JS `v14` | ✅ +Node.JS `v12` | ✅ +Node.JS `v10` | ✅ +Node.JS `v8` | See [Node Support](#node-support) below +Web Browsers | ✅ See [Browser Support](#browser-support) below + +### Node Support +Automated tests are run using the latest release of each currently supported LTS version of Node.JS. +While Node.JS v8 is no longer supported by the Node.JS team, the latest version of Node.JS v8 is still included in our testing suite. +Please note that versions of Node.JS v8 prior to `v8.5.0` will NOT work, because OpenTelemetry Node depends on the `perf_hooks` module introduced in `v8.5.0` + +### Browser Support +Automated browser tests are run in the latest version of Headless Chrome. +There is currently no list of officially supported browsers, but OpenTelemetry is developed using standard web technologies with wide support and should work in currently supported versions of major browsers. ## Release Schedule