Skip to content
This repository was archived by the owner on Nov 10, 2022. It is now read-only.

Commit 25cf8a4

Browse files
authored
chore: release 1.0 proposal (#92)
1 parent 3b246e0 commit 25cf8a4

File tree

7 files changed

+53
-4
lines changed

7 files changed

+53
-4
lines changed

CHANGELOG.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,21 @@
22

33
All notable changes to this project will be documented in this file.
44

5+
## 1.0.0
6+
7+
### :memo: Documentation
8+
9+
* [#89](https://github.com/open-telemetry/opentelemetry-js-api/pull/89) chore: update upgrade guidelines ([@dyladan](https://github.com/dyladan))
10+
11+
### :house: Internal
12+
13+
* [#90](https://github.com/open-telemetry/opentelemetry-js-api/pull/90) chore: enable typescript 4.3 noImplicitOverride option ([@Flarna](https://github.com/Flarna))
14+
15+
### Committers: 2
16+
17+
* Daniel Dyla ([@dyladan](https://github.com/dyladan))
18+
* Gerhard Stöbich ([@Flarna](https://github.com/Flarna))
19+
520
## 0.21.0
621

722
### :boom: Breaking Change

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,10 @@ Because the npm installer and node module resolution algorithm could potentially
105105

106106
## Upgrade Guidelines
107107

108+
### 0.21.0 to 1.0.0
109+
110+
No breaking changes
111+
108112
### 0.20.0 to 0.21.0
109113

110114
- [#78](https://github.com/open-telemetry/opentelemetry-js-api/issues/78) `api.context.bind` arguments reversed and `context` is now a required argument.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@opentelemetry/api",
3-
"version": "0.21.0",
3+
"version": "1.0.0",
44
"description": "Public API for OpenTelemetry",
55
"main": "build/src/index.js",
66
"module": "build/esm/index.js",

src/internal/global-utils.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ import { isCompatible } from './semver';
2525

2626
const major = VERSION.split('.')[0];
2727
const GLOBAL_OPENTELEMETRY_API_KEY = Symbol.for(
28-
`io.opentelemetry.js.api.${major}`
28+
`opentelemetry.js.api.${major}`
2929
);
3030

3131
const _global = _globalThis as OTelGlobal;

src/version.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,4 @@
1515
*/
1616

1717
// this is autogenerated file, see scripts/version-update.js
18-
export const VERSION = '0.21.0';
18+
export const VERSION = '1.0.0';

test/internal/global.test.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ const api2 = require('../../src') as typeof import('../../src');
3131

3232
// This will need to be changed manually on major version changes.
3333
// It is intentionally not autogenerated to ensure the author of the change is aware of what they are doing.
34-
const GLOBAL_API_SYMBOL_KEY = 'io.opentelemetry.js.api.0';
34+
const GLOBAL_API_SYMBOL_KEY = 'opentelemetry.js.api.1';
3535

3636
const getMockLogger = () => ({
3737
verbose: sinon.spy(),

test/internal/version.test.ts

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
/*
2+
* Copyright The OpenTelemetry Authors
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* https://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
import * as assert from 'assert';
18+
import { VERSION } from '../../src/version';
19+
20+
describe('version', () => {
21+
it('should have generated VERSION.ts', () => {
22+
const pjson = require('../../package.json');
23+
assert.strictEqual(pjson.version, VERSION);
24+
});
25+
26+
it('prerelease tag versions are banned', () => {
27+
// see https://github.com/open-telemetry/opentelemetry-js-api/issues/74
28+
assert.ok(VERSION.match(/^\d+\.\d+\.\d+$/));
29+
});
30+
});

0 commit comments

Comments
 (0)