From f52d89af8a44754d6cc16eca59794722030315e4 Mon Sep 17 00:00:00 2001
From: legendecas
Date: Thu, 16 Dec 2021 17:02:17 +0800
Subject: [PATCH 1/8] chore: checks links in typedoc html
---
.github/workflows/lint.yml | 11 ++++++++--
.github/workflows/markdown-lint.config.json | 11 ----------
.github/workflows/markdown-lint.yml | 19 -----------------
README.md | 8 +++----
package.json | 2 ++
tsconfig.json | 23 +++++++++++----------
6 files changed, 27 insertions(+), 47 deletions(-)
delete mode 100644 .github/workflows/markdown-lint.config.json
delete mode 100644 .github/workflows/markdown-lint.yml
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
index d90afefbdc..eef568f45d 100644
--- a/.github/workflows/lint.yml
+++ b/.github/workflows/lint.yml
@@ -45,7 +45,7 @@ jobs:
experimental/node_modules
*/*/node_modules
experimental/*/*/node_modules
- key: lint-${{ matrix.package-group }}-${{ runner.os }}-${{ matrix.node_version }}-${{ hashFiles('**/package.json') }}-20211009.2
+ key: lint-${{ matrix.package-group }}-${{ runner.os }}-${{ matrix.node_version }}-${{ hashFiles('**/package.json') }}-20211216.2
# On a cache miss, install dependencies
- name: Bootstrap
@@ -53,10 +53,17 @@ jobs:
working-directory: ${{ matrix.package-group }}
run: |
npm install --ignore-scripts
- npx lerna bootstrap --no-ci --ignore-scripts --hoist --nohoist='zone.js' -- --only=dev
+ npx lerna bootstrap --no-ci --hoist --nohoist='zone.js'
- name: Lint
working-directory: ${{ matrix.package-group }}
run: |
npm run lint
npm run lint:examples
+
+ - name: Lint doc files
+ if: ${{ matrix.package-group == '.' }}
+ run: |
+ npm run compile
+ npm run docs
+ npm run docs:test
diff --git a/.github/workflows/markdown-lint.config.json b/.github/workflows/markdown-lint.config.json
deleted file mode 100644
index e36e46b077..0000000000
--- a/.github/workflows/markdown-lint.config.json
+++ /dev/null
@@ -1,11 +0,0 @@
-{
- "retryOn429": true,
- "ignorePatterns": [
- {
- "pattern": "^http://localhost"
- },
- {
- "pattern": "^https://github.com/snyder114"
- }
- ]
-}
diff --git a/.github/workflows/markdown-lint.yml b/.github/workflows/markdown-lint.yml
deleted file mode 100644
index b73acf42a8..0000000000
--- a/.github/workflows/markdown-lint.yml
+++ /dev/null
@@ -1,19 +0,0 @@
-name: Markdown Linter
-
-# Link checking costs tens of minutes to run.
-# Runs everyday at 9 am.
-on:
- schedule:
- - cron: "0 9 * * *"
-
-jobs:
- markdown-link-check:
- runs-on: ubuntu-latest
- steps:
- - uses: actions/checkout@master
- - uses: gaurav-nelson/github-action-markdown-link-check@v1
- # checks all markdown including all subfolders
- with:
- use-quiet-mode: 'yes'
- use-verbose-mode: 'yes'
- config-file: '.github/workflows/markdown-lint.config.json'
diff --git a/README.md b/README.md
index b64fa35e78..bd1e68f2d5 100644
--- a/README.md
+++ b/README.md
@@ -33,8 +33,6 @@
•
Development Guide
•
- Benchmarks
- •
Examples
@@ -174,7 +172,7 @@ For a more detailed breakdown of feature support see the [specification complian
We'd love your help!. Use tags [up-for-grabs][up-for-grabs-issues] and
[good first issue][good-first-issues] to get started with the project. For
instructions to build and make changes to this project, see the
-[CONTRIBUTING](CONTRIBUTING.md) guide.
+[CONTRIBUTING][CONTRIBUTING] guide.
We have a weekly SIG meeting! See the [community page](https://github.com/open-telemetry/community#javascript-sdk) for meeting details and notes.
@@ -370,7 +368,7 @@ Collector exporter packages and types are renamed:
- All plugins have been removed in favor of instrumentations.
-- The `@opentelemetry/propagator-b3` package previously exported three propagators: `B3Propagator`,`B3SinglePropagator`, and `B3MultiPropagator`, but now only exports the `B3Propagator`. It extracts b3 context in single and multi-header encodings, and injects context using the single-header encoding by default, but can be configured to inject context using the multi-header endcoding during construction: `new B3Propagator({ injectEncoding: B3InjectEncoding.MULTI_HEADER })`. If you were previously using the `B3SinglePropagator` or `B3MultiPropagator` directly, you should update your code to use the `B3Propagator` with the appropriate configuration. See the [readme](./packages/opentelemetry-propagator-b3/README.md) for full details and usage.
+- The `@opentelemetry/propagator-b3` package previously exported three propagators: `B3Propagator`,`B3SinglePropagator`, and `B3MultiPropagator`, but now only exports the `B3Propagator`. It extracts b3 context in single and multi-header encodings, and injects context using the single-header encoding by default, but can be configured to inject context using the multi-header endcoding during construction: `new B3Propagator({ injectEncoding: B3InjectEncoding.MULTI_HEADER })`. If you were previously using the `B3SinglePropagator` or `B3MultiPropagator` directly, you should update your code to use the `B3Propagator` with the appropriate configuration. See the [readme][otel-propagator-b3] for full details and usage.
- Sampling configuration via environment variable has changed. If you were using `OTEL_SAMPLING_PROBABILITY` then you should replace it with `OTEL_TRACES_SAMPLER=parentbased_traceidratio` and `OTEL_TRACES_SAMPLER_ARG=` where `` is a number in the [0..1] range, e.g. "0.25". Default is 1.0 if unset.
@@ -535,6 +533,7 @@ Apache 2.0 - See [LICENSE][license-url] for more information.
[docs]: https://open-telemetry.github.io/opentelemetry-js
[compliance-matrix]: https://github.com/open-telemetry/opentelemetry-specification/blob/main/spec-compliance-matrix.md
+[CONTRIBUTING]: https://github.com/open-telemetry/opentelemetry-js/blob/main/CONTRIBUTING.md
[otel-metrics]: https://github.com/open-telemetry/opentelemetry-js/tree/main/experimental/packages/opentelemetry-sdk-metrics-base
[otel-node]: https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-sdk-trace-node
@@ -549,6 +548,7 @@ Apache 2.0 - See [LICENSE][license-url] for more information.
[otel-web]: https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-sdk-trace-web
[otel-api]: https://github.com/open-telemetry/opentelemetry-js-api
[otel-core]: https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-core
+[otel-propagator-b3]: https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-propagator-b3
[generate-api-documentation]: https://github.com/open-telemetry/opentelemetry-js/blob/main/CONTRIBUTING.md#generating-api-documentation
[otel-contrib-instrumentation-dns]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-dns
diff --git a/package.json b/package.json
index 2a2dc9bf8f..926f153bc5 100644
--- a/package.json
+++ b/package.json
@@ -26,6 +26,7 @@
"predocs-test": "npm run docs",
"docs": "typedoc && touch docs/.nojekyll",
"docs-deploy": "gh-pages --dotfiles --dist docs",
+ "docs:test": "linkinator docs --silent && linkinator doc/*.md --silent",
"lint": "lerna run lint",
"lint:changed": "lerna run --concurrency 1 --stream lint --since HEAD --exclude-dependents",
"lint:fix": "lerna run lint:fix",
@@ -63,6 +64,7 @@
"husky": "4.3.8",
"lerna": "3.22.1",
"lerna-changelog": "1.0.1",
+ "linkinator": "^2.16.2",
"markdownlint-cli": "0.29.0",
"semver": "7.3.5",
"typedoc": "0.22.9",
diff --git a/tsconfig.json b/tsconfig.json
index 642d15e794..4362936fff 100644
--- a/tsconfig.json
+++ b/tsconfig.json
@@ -2,7 +2,8 @@
"extends": "./tsconfig.base.json",
"files": [],
"typedocOptions": {
- "packages": [
+ "entryPointStrategy": "packages",
+ "entryPoints": [
"experimental/packages/opentelemetry-api-metrics",
"experimental/packages/opentelemetry-exporter-trace-otlp-grpc",
"experimental/packages/opentelemetry-exporter-trace-otlp-http",
@@ -13,6 +14,7 @@
"experimental/packages/opentelemetry-instrumentation-http",
"experimental/packages/opentelemetry-instrumentation-xml-http-request",
"experimental/packages/opentelemetry-instrumentation",
+ "experimental/packages/opentelemetry-sdk-metrics-base",
"experimental/packages/opentelemetry-sdk-node",
"experimental/packages/opentelemetry-exporter-metrics-otlp-http",
"experimental/packages/opentelemetry-exporter-metrics-otlp-grpc",
@@ -26,7 +28,6 @@
"packages/opentelemetry-propagator-b3",
"packages/opentelemetry-propagator-jaeger",
"packages/opentelemetry-resources",
- "packages/opentelemetry-sdk-metrics-base",
"packages/opentelemetry-sdk-trace-base",
"packages/opentelemetry-sdk-trace-node",
"packages/opentelemetry-sdk-trace-web",
@@ -48,40 +49,40 @@
"path": "packages/opentelemetry-context-async-hooks"
},
{
- "path": "packages/opentelemetry-context-zone-peer-dep/tsconfig.all.json"
+ "path": "packages/opentelemetry-context-zone-peer-dep"
},
{
- "path": "packages/opentelemetry-context-zone/tsconfig.all.json"
+ "path": "packages/opentelemetry-context-zone"
},
{
- "path": "packages/opentelemetry-core/tsconfig.all.json"
+ "path": "packages/opentelemetry-core"
},
{
"path": "packages/opentelemetry-exporter-jaeger"
},
{
- "path": "packages/opentelemetry-exporter-zipkin/tsconfig.all.json"
+ "path": "packages/opentelemetry-exporter-zipkin"
},
{
- "path": "packages/opentelemetry-propagator-b3/tsconfig.all.json"
+ "path": "packages/opentelemetry-propagator-b3"
},
{
"path": "packages/opentelemetry-propagator-jaeger"
},
{
- "path": "packages/opentelemetry-resources/tsconfig.all.json"
+ "path": "packages/opentelemetry-resources"
},
{
- "path": "packages/opentelemetry-sdk-trace-base/tsconfig.all.json"
+ "path": "packages/opentelemetry-sdk-trace-base"
},
{
"path": "packages/opentelemetry-sdk-trace-node"
},
{
- "path": "packages/opentelemetry-sdk-trace-web/tsconfig.all.json"
+ "path": "packages/opentelemetry-sdk-trace-web"
},
{
- "path": "packages/opentelemetry-semantic-conventions/tsconfig.all.json"
+ "path": "packages/opentelemetry-semantic-conventions"
},
{
"path": "packages/opentelemetry-shim-opentracing"
From ca8b30e653c641d17bff200f1ba27c06b1cb53b6 Mon Sep 17 00:00:00 2001
From: legendecas
Date: Fri, 24 Dec 2021 00:20:11 +0800
Subject: [PATCH 2/8] fixup! checkout submodules
---
.github/workflows/lint.yml | 2 ++
1 file changed, 2 insertions(+)
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
index eef568f45d..bdc0c2c720 100644
--- a/.github/workflows/lint.yml
+++ b/.github/workflows/lint.yml
@@ -18,6 +18,8 @@ jobs:
steps:
- uses: actions/checkout@v2
+ with:
+ submodules: true
- name: Lint changelog file
if: ${{ matrix.package-group == '.' }}
From 20bf65f250c968ed435d717b815a0036efd3dae8 Mon Sep 17 00:00:00 2001
From: legendecas
Date: Fri, 24 Dec 2021 00:28:01 +0800
Subject: [PATCH 3/8] fixup! missing git
---
.github/workflows/lint.yml | 6 ++++--
1 file changed, 4 insertions(+), 2 deletions(-)
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
index bdc0c2c720..e025385680 100644
--- a/.github/workflows/lint.yml
+++ b/.github/workflows/lint.yml
@@ -13,10 +13,12 @@ jobs:
matrix:
package-group: [".", "experimental"]
runs-on: ubuntu-latest
- container:
- image: node:14
steps:
+ - uses: actions/setup-node@v2
+ with:
+ node-version: '14'
+
- uses: actions/checkout@v2
with:
submodules: true
From dba59f5468d4f4b8fdb776d0ca099f1847fd8789 Mon Sep 17 00:00:00 2001
From: legendecas
Date: Fri, 24 Dec 2021 00:33:31 +0800
Subject: [PATCH 4/8] fixup! markdownlint ignore submodules
---
.github/workflows/lint.yml | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
index e025385680..a314813f1e 100644
--- a/.github/workflows/lint.yml
+++ b/.github/workflows/lint.yml
@@ -38,7 +38,8 @@ jobs:
if: ${{ matrix.package-group == '.' }}
uses: avto-dev/markdown-lint@v1
with:
- args: "./**/*.md -i ./CHANGELOG.md"
+ args: "./**/*.md"
+ ignore: './CHANGELOG.md ./experimental/packages/opentelemetry-exporter-metrics-otlp-grpc/protos ./experimental/packages/opentelemetry-exporter-metrics-otlp-proto/protos ./packages/exporter-trace-otlp-grpc/protos ./packages/exporter-trace-otlp-proto/protos'
- name: restore lerna
id: cache
From 0e700835dae85c68878a53743ae45e55f7bd1b1d Mon Sep 17 00:00:00 2001
From: legendecas
Date: Fri, 24 Dec 2021 00:47:49 +0800
Subject: [PATCH 5/8] fixup! typedoc config
---
tsconfig.json | 5 ++---
1 file changed, 2 insertions(+), 3 deletions(-)
diff --git a/tsconfig.json b/tsconfig.json
index 0bae1a80be..2a2648786c 100644
--- a/tsconfig.json
+++ b/tsconfig.json
@@ -2,8 +2,8 @@
"extends": "./tsconfig.base.json",
"files": [],
"typedocOptions": {
- "packages": [
- "experimental/packages/opentelemetry-api-metrics",
+ "entryPointStrategy": "packages",
+ "entryPoints": [
"experimental/packages/opentelemetry-exporter-metrics-otlp-grpc",
"experimental/packages/opentelemetry-exporter-metrics-otlp-http",
"experimental/packages/opentelemetry-exporter-metrics-otlp-proto",
@@ -26,7 +26,6 @@
"packages/opentelemetry-propagator-b3",
"packages/opentelemetry-propagator-jaeger",
"packages/opentelemetry-resources",
- "packages/opentelemetry-sdk-metrics-base",
"packages/opentelemetry-sdk-trace-base",
"packages/opentelemetry-sdk-trace-node",
"packages/opentelemetry-sdk-trace-web",
From 974737b97d826ce67e483b916fcad08729abec43 Mon Sep 17 00:00:00 2001
From: legendecas
Date: Fri, 24 Dec 2021 01:04:30 +0800
Subject: [PATCH 6/8] fixup! increase memory limit
---
.github/workflows/lint.yml | 4 +---
1 file changed, 1 insertion(+), 3 deletions(-)
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
index a314813f1e..a788117159 100644
--- a/.github/workflows/lint.yml
+++ b/.github/workflows/lint.yml
@@ -20,8 +20,6 @@ jobs:
node-version: '14'
- uses: actions/checkout@v2
- with:
- submodules: true
- name: Lint changelog file
if: ${{ matrix.package-group == '.' }}
@@ -71,4 +69,4 @@ jobs:
run: |
npm run compile
npm run docs
- npm run docs:test
+ NODE_OPTIONS=--max npm run docs:test
From da9ae43a56f2c245043e6fa3c60a698d8de6b4c3 Mon Sep 17 00:00:00 2001
From: legendecas
Date: Tue, 28 Dec 2021 23:34:45 +0800
Subject: [PATCH 7/8] fixup! increase memory limit
---
.github/workflows/lint.yml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
index a788117159..f48d2f1a16 100644
--- a/.github/workflows/lint.yml
+++ b/.github/workflows/lint.yml
@@ -69,4 +69,4 @@ jobs:
run: |
npm run compile
npm run docs
- NODE_OPTIONS=--max npm run docs:test
+ NODE_OPTIONS=--max-old-space-size=4096 npm run docs:test
From fb01d9d29cbc98555793a628f40297b3adf734c8 Mon Sep 17 00:00:00 2001
From: legendecas
Date: Tue, 28 Dec 2021 23:56:20 +0800
Subject: [PATCH 8/8] fixup! increase memory limit
---
.github/workflows/lint.yml | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
index f48d2f1a16..9b96d1a633 100644
--- a/.github/workflows/lint.yml
+++ b/.github/workflows/lint.yml
@@ -68,5 +68,5 @@ jobs:
if: ${{ matrix.package-group == '.' }}
run: |
npm run compile
- npm run docs
- NODE_OPTIONS=--max-old-space-size=4096 npm run docs:test
+ NODE_OPTIONS=--max-old-space-size=4096 npm run docs
+ npm run docs:test