From 504041a8aa8442987a95f675af0a402084678682 Mon Sep 17 00:00:00 2001 From: Daniel Dyla Date: Fri, 12 Mar 2021 12:11:15 -0500 Subject: [PATCH] chore: v1.0.0-rc.0 release proposal (#21) --- CHANGELOG.md | 12 ++++++++++++ package.json | 2 +- src/version.ts | 2 +- test/internal/global.test.ts | 8 ++++++-- 4 files changed, 20 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index a604752e..923626d1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,18 @@ All notable changes to this project will be documented in this file. +## 1.0.0-rc.0 + +### :memo: Documentation + +* [#20](https://github.com/open-telemetry/opentelemetry-js-api/pull/20) docs: document latest manual tracing ([@dyladan](https://github.com/dyladan)) +* [#18](https://github.com/open-telemetry/opentelemetry-js-api/pull/18) chore: deploy docs on a release ([@dyladan](https://github.com/dyladan)) +* [#19](https://github.com/open-telemetry/opentelemetry-js-api/pull/19) docs: fix readme links ([@dyladan](https://github.com/dyladan)) + +### Committers: 1 + +* Daniel Dyla ([@dyladan](https://github.com/dyladan)) + ## 0.18.1 ### :bug: Bug Fix diff --git a/package.json b/package.json index cdfdde89..297491dd 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@opentelemetry/api", - "version": "0.18.1", + "version": "1.0.0-rc.0", "description": "Public API for OpenTelemetry", "main": "build/src/index.js", "types": "build/src/index.d.ts", diff --git a/src/version.ts b/src/version.ts index ae3e6d64..04dec95c 100644 --- a/src/version.ts +++ b/src/version.ts @@ -15,4 +15,4 @@ */ // this is autogenerated file, see scripts/version-update.js -export const VERSION = '0.18.1'; +export const VERSION = '1.0.0-rc.0'; diff --git a/test/internal/global.test.ts b/test/internal/global.test.ts index fc1f0a76..3932722b 100644 --- a/test/internal/global.test.ts +++ b/test/internal/global.test.ts @@ -28,6 +28,10 @@ for (const key of Object.keys(require.cache)) { } const api2 = require('../../src') as typeof import('../../src'); +// This will need to be changed manually on major version changes. +// It is intentionally not autogenerated to ensure the author of the change is aware of what they are doing. +const GLOBAL_API_SYMBOL_KEY = 'io.opentelemetry.js.api.1'; + describe('Global Utils', () => { // prove they are separate instances assert.notEqual(api1, api2); @@ -43,7 +47,7 @@ describe('Global Utils', () => { api1.trace.disable(); api1.diag.disable(); // @ts-expect-error we are modifying internals for testing purposes here - delete _globalThis[Symbol.for('io.opentelemetry.js.api.0')]; + delete _globalThis[Symbol.for(GLOBAL_API_SYMBOL_KEY)]; }); it('should change the global context manager', () => { @@ -82,7 +86,7 @@ describe('Global Utils', () => { const globalInstance = getGlobal('context'); assert.ok(globalInstance); // @ts-expect-error we are modifying internals for testing purposes here - _globalThis[Symbol.for('io.opentelemetry.js.api.0')].version = '0.0.1'; + _globalThis[Symbol.for(GLOBAL_API_SYMBOL_KEY)].version = '0.0.1'; assert.strictEqual(api1.context['_getContextManager'](), original); });