From f4c99dc85b73cf062603b9dd791f5162e30da0ac Mon Sep 17 00:00:00 2001 From: Trent Mick Date: Wed, 22 May 2024 16:56:59 -0700 Subject: [PATCH 1/8] chore(lint): refactor Markdown linting to use markdownlint-cli2 This switches from `markdownlint-cli` to `markdownlint-cli2` and drops usage of the https://github.com/avto-dev/markdown-lint GitHub action in CI. - The `avto-dev/markdown-lint` action was using a 4y old version of `markdownlint`. AFAICT that action is not being maintained. - There is a new `npm run lint:markdown` and the `lint.yml` CI workflow uses it. - The switch from `markdownlint-cli` to `markdownlint-cli2` and `.markdownlint-cli2.jsonc` as the config allows using the https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint VSCode plugin for in-editor Markdown lint warnings and intellisense in the config file. Refs: https://github.com/open-telemetry/opentelemetry-js/pull/4713 --- .github/ISSUE_TEMPLATE/plugin_request.md | 2 + .github/markdown-lint.yml | 5 - .github/workflows/lint.yml | 12 +- .markdownlint-cli2.jsonc | 17 + .markdownlint.json | 7 - package-lock.json | 326 ++++++++++++++++++ package.json | 5 +- .../README.md | 2 - 8 files changed, 352 insertions(+), 24 deletions(-) delete mode 100644 .github/markdown-lint.yml create mode 100644 .markdownlint-cli2.jsonc delete mode 100644 .markdownlint.json diff --git a/.github/ISSUE_TEMPLATE/plugin_request.md b/.github/ISSUE_TEMPLATE/plugin_request.md index 1936ace6c8..2f588b9759 100644 --- a/.github/ISSUE_TEMPLATE/plugin_request.md +++ b/.github/ISSUE_TEMPLATE/plugin_request.md @@ -20,9 +20,11 @@ A clear and concise description of what the problem is. Ex. I'm always frustrate ### Do you expect this instrumentation to be commonly used? + Weekly Downloads: ### What version of instrumentation are you interested in using? + Versions: ### Additional context diff --git a/.github/markdown-lint.yml b/.github/markdown-lint.yml deleted file mode 100644 index f4885f1be4..0000000000 --- a/.github/markdown-lint.yml +++ /dev/null @@ -1,5 +0,0 @@ -# MD004 - Unordered list style -# This rule is triggered when the symbols used in the document for unordered list items do not match the configured unordered list style -# * Item 1 // Error: Unordered list style [Expected: dash; Actual: asterisk] -MD004: - style: dash \ No newline at end of file diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index 0622459ce0..a30b2bbe56 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -15,14 +15,8 @@ jobs: with: node-version: 18 cache: 'npm' - - - name: Lint markdown files - uses: avto-dev/markdown-lint@v1 - with: - config: '.github/markdown-lint.yml' - ignore: "./**/CHANGELOG.md" - args: "./**/*.md" - - run: npm ci - name: Lint - run: npm run lint + run: | + npm run lint + npm run lint:markdown diff --git a/.markdownlint-cli2.jsonc b/.markdownlint-cli2.jsonc new file mode 100644 index 0000000000..b9cee8163a --- /dev/null +++ b/.markdownlint-cli2.jsonc @@ -0,0 +1,17 @@ +// https://github.com/DavidAnson/markdownlint-cli2#markdownlint-cli2jsonc +{ + "config": { + // https://github.com/DavidAnson/markdownlint/blob/main/README.md#rules--aliases + "MD013": false, + "MD024": false, + "MD033": false, + "MD041": false, + "MD012": false, // no-multiple-blanks, common in CHANGELOG.md files + "MD045": false, // XXX no-alt-text + "MD026": false, // XXX drop? + // "MD004": { "style": "dash" } // ul-style + }, + "gitignore": true, + "noBanner": true, + "noProgress": true +} diff --git a/.markdownlint.json b/.markdownlint.json deleted file mode 100644 index b5a4fe3721..0000000000 --- a/.markdownlint.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "MD013": false, - "MD024": false, - "MD033": false, - "MD041": false - } - \ No newline at end of file diff --git a/package-lock.json b/package-lock.json index 96bfea2bfc..368694c701 100644 --- a/package-lock.json +++ b/package-lock.json @@ -29,6 +29,7 @@ "glob": "^10.3.10", "lerna": "6.6.2", "lerna-changelog": "2.2.0", + "markdownlint-cli2": "0.13.0", "minimatch": "^9.0.3", "prettier": "2.8.8", "semver": "^7.6.0", @@ -9925,6 +9926,18 @@ "integrity": "sha512-+Fj43pSMwJs4KRrH/938Uf+uAELIgVBmQzg/q1YG10djyfA3TnrU8N8XzqCh/okZdszqBQTZf96idMfE5lnwTA==", "dev": true }, + "node_modules/@sindresorhus/merge-streams": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/@sindresorhus/merge-streams/-/merge-streams-2.3.0.tgz", + "integrity": "sha512-LtoMMhxAlorcGhmFYI+LhPgbPZCkgP6ra1YL604EeF6U98pLlQ3iWIGMdWSC+vWmPBWBNgmDBAhnAobLROJmwg==", + "dev": true, + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/@sinonjs/commons": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/@sinonjs/commons/-/commons-2.0.0.tgz", @@ -23353,6 +23366,15 @@ "node": "^12.20.0 || ^14.13.1 || >=16.0.0" } }, + "node_modules/linkify-it": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/linkify-it/-/linkify-it-5.0.0.tgz", + "integrity": "sha512-5aHCbzQRADcdP+ATqnDuhhJ/MRIqDkZX5pyjFHRRysS8vZ5AbqGEoFIb6pYHPZ+L/OC2Lc+xT8uHVVR5CAK/wQ==", + "dev": true, + "dependencies": { + "uc.micro": "^2.0.0" + } + }, "node_modules/load-json-file": { "version": "6.2.0", "resolved": "https://registry.npmjs.org/load-json-file/-/load-json-file-6.2.0.tgz", @@ -23981,6 +24003,145 @@ "node": ">=0.10.0" } }, + "node_modules/markdown-it": { + "version": "14.1.0", + "resolved": "https://registry.npmjs.org/markdown-it/-/markdown-it-14.1.0.tgz", + "integrity": "sha512-a54IwgWPaeBCAAsv13YgmALOF1elABB08FxO9i+r4VFk5Vl4pKokRPeX8u5TCgSsPi6ec1otfLjdOpVcgbpshg==", + "dev": true, + "dependencies": { + "argparse": "^2.0.1", + "entities": "^4.4.0", + "linkify-it": "^5.0.0", + "mdurl": "^2.0.0", + "punycode.js": "^2.3.1", + "uc.micro": "^2.1.0" + }, + "bin": { + "markdown-it": "bin/markdown-it.mjs" + } + }, + "node_modules/markdown-it/node_modules/entities": { + "version": "4.5.0", + "resolved": "https://registry.npmjs.org/entities/-/entities-4.5.0.tgz", + "integrity": "sha512-V0hjH4dGPh9Ao5p0MoRY6BVqtwCjhz6vI5LT8AJ55H+4g9/4vbHx1I54fS0XuclLhDHArPQCiMjDxjaL8fPxhw==", + "dev": true, + "engines": { + "node": ">=0.12" + }, + "funding": { + "url": "https://github.com/fb55/entities?sponsor=1" + } + }, + "node_modules/markdownlint": { + "version": "0.34.0", + "resolved": "https://registry.npmjs.org/markdownlint/-/markdownlint-0.34.0.tgz", + "integrity": "sha512-qwGyuyKwjkEMOJ10XN6OTKNOVYvOIi35RNvDLNxTof5s8UmyGHlCdpngRHoRGNvQVGuxO3BJ7uNSgdeX166WXw==", + "dev": true, + "dependencies": { + "markdown-it": "14.1.0", + "markdownlint-micromark": "0.1.9" + }, + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/DavidAnson" + } + }, + "node_modules/markdownlint-cli2": { + "version": "0.13.0", + "resolved": "https://registry.npmjs.org/markdownlint-cli2/-/markdownlint-cli2-0.13.0.tgz", + "integrity": "sha512-Pg4nF7HlopU97ZXtrcVISWp3bdsuc5M0zXyLp2/sJv2zEMlInrau0ZKK482fQURzVezJzWBpNmu4u6vGAhij+g==", + "dev": true, + "dependencies": { + "globby": "14.0.1", + "js-yaml": "4.1.0", + "jsonc-parser": "3.2.1", + "markdownlint": "0.34.0", + "markdownlint-cli2-formatter-default": "0.0.4", + "micromatch": "4.0.5" + }, + "bin": { + "markdownlint-cli2": "markdownlint-cli2.js" + }, + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/DavidAnson" + } + }, + "node_modules/markdownlint-cli2-formatter-default": { + "version": "0.0.4", + "resolved": "https://registry.npmjs.org/markdownlint-cli2-formatter-default/-/markdownlint-cli2-formatter-default-0.0.4.tgz", + "integrity": "sha512-xm2rM0E+sWgjpPn1EesPXx5hIyrN2ddUnUwnbCsD/ONxYtw3PX6LydvdH6dciWAoFDpwzbHM1TO7uHfcMd6IYg==", + "dev": true, + "peerDependencies": { + "markdownlint-cli2": ">=0.0.4" + } + }, + "node_modules/markdownlint-cli2/node_modules/globby": { + "version": "14.0.1", + "resolved": "https://registry.npmjs.org/globby/-/globby-14.0.1.tgz", + "integrity": "sha512-jOMLD2Z7MAhyG8aJpNOpmziMOP4rPLcc95oQPKXBazW82z+CEgPFBQvEpRUa1KeIMUJo4Wsm+q6uzO/Q/4BksQ==", + "dev": true, + "dependencies": { + "@sindresorhus/merge-streams": "^2.1.0", + "fast-glob": "^3.3.2", + "ignore": "^5.2.4", + "path-type": "^5.0.0", + "slash": "^5.1.0", + "unicorn-magic": "^0.1.0" + }, + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/markdownlint-cli2/node_modules/jsonc-parser": { + "version": "3.2.1", + "resolved": "https://registry.npmjs.org/jsonc-parser/-/jsonc-parser-3.2.1.tgz", + "integrity": "sha512-AilxAyFOAcK5wA1+LeaySVBrHsGQvUFCDWXKpZjzaL0PqW+xfBOttn8GNtWKFWqneyMZj41MWF9Kl6iPWLwgOA==", + "dev": true + }, + "node_modules/markdownlint-cli2/node_modules/path-type": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/path-type/-/path-type-5.0.0.tgz", + "integrity": "sha512-5HviZNaZcfqP95rwpv+1HDgUamezbqdSYTyzjTvwtJSnIH+3vnbmWsItli8OFEndS984VT55M3jduxZbX351gg==", + "dev": true, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/markdownlint-cli2/node_modules/slash": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/slash/-/slash-5.1.0.tgz", + "integrity": "sha512-ZA6oR3T/pEyuqwMgAKT0/hAv8oAXckzbkmR0UkUosQ+Mc4RxGoJkRmwHgHufaenlyAgE1Mxgpdcrf75y6XcnDg==", + "dev": true, + "engines": { + "node": ">=14.16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/markdownlint-micromark": { + "version": "0.1.9", + "resolved": "https://registry.npmjs.org/markdownlint-micromark/-/markdownlint-micromark-0.1.9.tgz", + "integrity": "sha512-5hVs/DzAFa8XqYosbEAEg6ok6MF2smDj89ztn9pKkCtdKHVdPQuGMH7frFfYL9mLkvfFe4pTyAMffLbjf3/EyA==", + "dev": true, + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/DavidAnson" + } + }, "node_modules/marky": { "version": "1.2.5", "resolved": "https://registry.npmjs.org/marky/-/marky-1.2.5.tgz", @@ -23998,6 +24159,12 @@ "safe-buffer": "^5.1.2" } }, + "node_modules/mdurl": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/mdurl/-/mdurl-2.0.0.tgz", + "integrity": "sha512-Lf+9+2r+Tdp5wXDXC4PcIBjTDtq4UKjCPMQhKIuzpJNW0b96kVqSwW0bT7FhRSfmAiFYgP+SCRvdrDozfh0U5w==", + "dev": true + }, "node_modules/media-typer": { "version": "0.3.0", "resolved": "https://registry.npmjs.org/media-typer/-/media-typer-0.3.0.tgz", @@ -29427,6 +29594,15 @@ "node": ">=6" } }, + "node_modules/punycode.js": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/punycode.js/-/punycode.js-2.3.1.tgz", + "integrity": "sha512-uxFIHU0YlHYhDQtV4R9J6a52SLx28BCjT+4ieh7IGbgwVJWO+km431c4yRlREUAsAmt/uMjQUyQHNEPf0M39CA==", + "dev": true, + "engines": { + "node": ">=6" + } + }, "node_modules/puppeteer-core": { "version": "22.4.1", "resolved": "https://registry.npmjs.org/puppeteer-core/-/puppeteer-core-22.4.1.tgz", @@ -34398,6 +34574,12 @@ "node": "*" } }, + "node_modules/uc.micro": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/uc.micro/-/uc.micro-2.1.0.tgz", + "integrity": "sha512-ARDJmphmdvUk6Glw7y9DQ2bFkKBHwQHLi2lsaH6PPmz/Ka9sFOBsBluozhDltWmnv9u/cF6Rt87znRTPV+yp/A==", + "dev": true + }, "node_modules/uglify-js": { "version": "3.17.4", "resolved": "https://registry.npmjs.org/uglify-js/-/uglify-js-3.17.4.tgz", @@ -34487,6 +34669,18 @@ "integrity": "sha512-JlCMO+ehdEIKqlFxk6IfVoAUVmgz7cU7zD/h9XZ0qzeosSHmUJVOzSQvvYSYWXkFXC+IfLKSIffhv0sVZup6pA==", "dev": true }, + "node_modules/unicorn-magic": { + "version": "0.1.0", + "resolved": "https://registry.npmjs.org/unicorn-magic/-/unicorn-magic-0.1.0.tgz", + "integrity": "sha512-lRfVq8fE8gz6QMBuDM6a+LO3IAzTi05H6gCVaUpir2E1Rwpo4ZUog45KpNXKC/Mn3Yb9UDuHumeFTo9iV/D9FQ==", + "dev": true, + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/union-value": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/union-value/-/union-value-1.0.1.tgz", @@ -49755,6 +49949,12 @@ "integrity": "sha512-+Fj43pSMwJs4KRrH/938Uf+uAELIgVBmQzg/q1YG10djyfA3TnrU8N8XzqCh/okZdszqBQTZf96idMfE5lnwTA==", "dev": true }, + "@sindresorhus/merge-streams": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/@sindresorhus/merge-streams/-/merge-streams-2.3.0.tgz", + "integrity": "sha512-LtoMMhxAlorcGhmFYI+LhPgbPZCkgP6ra1YL604EeF6U98pLlQ3iWIGMdWSC+vWmPBWBNgmDBAhnAobLROJmwg==", + "dev": true + }, "@sinonjs/commons": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/@sinonjs/commons/-/commons-2.0.0.tgz", @@ -60443,6 +60643,15 @@ "integrity": "sha512-wM1+Z03eypVAVUCE7QdSqpVIvelbOakn1M0bPDoA4SGWPx3sNDVUiMo3L6To6WWGClB7VyXnhQ4Sn7gxiJbE6A==", "dev": true }, + "linkify-it": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/linkify-it/-/linkify-it-5.0.0.tgz", + "integrity": "sha512-5aHCbzQRADcdP+ATqnDuhhJ/MRIqDkZX5pyjFHRRysS8vZ5AbqGEoFIb6pYHPZ+L/OC2Lc+xT8uHVVR5CAK/wQ==", + "dev": true, + "requires": { + "uc.micro": "^2.0.0" + } + }, "load-json-file": { "version": "6.2.0", "resolved": "https://registry.npmjs.org/load-json-file/-/load-json-file-6.2.0.tgz", @@ -60966,6 +61175,99 @@ "object-visit": "^1.0.0" } }, + "markdown-it": { + "version": "14.1.0", + "resolved": "https://registry.npmjs.org/markdown-it/-/markdown-it-14.1.0.tgz", + "integrity": "sha512-a54IwgWPaeBCAAsv13YgmALOF1elABB08FxO9i+r4VFk5Vl4pKokRPeX8u5TCgSsPi6ec1otfLjdOpVcgbpshg==", + "dev": true, + "requires": { + "argparse": "^2.0.1", + "entities": "^4.4.0", + "linkify-it": "^5.0.0", + "mdurl": "^2.0.0", + "punycode.js": "^2.3.1", + "uc.micro": "^2.1.0" + }, + "dependencies": { + "entities": { + "version": "4.5.0", + "resolved": "https://registry.npmjs.org/entities/-/entities-4.5.0.tgz", + "integrity": "sha512-V0hjH4dGPh9Ao5p0MoRY6BVqtwCjhz6vI5LT8AJ55H+4g9/4vbHx1I54fS0XuclLhDHArPQCiMjDxjaL8fPxhw==", + "dev": true + } + } + }, + "markdownlint": { + "version": "0.34.0", + "resolved": "https://registry.npmjs.org/markdownlint/-/markdownlint-0.34.0.tgz", + "integrity": "sha512-qwGyuyKwjkEMOJ10XN6OTKNOVYvOIi35RNvDLNxTof5s8UmyGHlCdpngRHoRGNvQVGuxO3BJ7uNSgdeX166WXw==", + "dev": true, + "requires": { + "markdown-it": "14.1.0", + "markdownlint-micromark": "0.1.9" + } + }, + "markdownlint-cli2": { + "version": "0.13.0", + "resolved": "https://registry.npmjs.org/markdownlint-cli2/-/markdownlint-cli2-0.13.0.tgz", + "integrity": "sha512-Pg4nF7HlopU97ZXtrcVISWp3bdsuc5M0zXyLp2/sJv2zEMlInrau0ZKK482fQURzVezJzWBpNmu4u6vGAhij+g==", + "dev": true, + "requires": { + "globby": "14.0.1", + "js-yaml": "4.1.0", + "jsonc-parser": "3.2.1", + "markdownlint": "0.34.0", + "markdownlint-cli2-formatter-default": "0.0.4", + "micromatch": "4.0.5" + }, + "dependencies": { + "globby": { + "version": "14.0.1", + "resolved": "https://registry.npmjs.org/globby/-/globby-14.0.1.tgz", + "integrity": "sha512-jOMLD2Z7MAhyG8aJpNOpmziMOP4rPLcc95oQPKXBazW82z+CEgPFBQvEpRUa1KeIMUJo4Wsm+q6uzO/Q/4BksQ==", + "dev": true, + "requires": { + "@sindresorhus/merge-streams": "^2.1.0", + "fast-glob": "^3.3.2", + "ignore": "^5.2.4", + "path-type": "^5.0.0", + "slash": "^5.1.0", + "unicorn-magic": "^0.1.0" + } + }, + "jsonc-parser": { + "version": "3.2.1", + "resolved": "https://registry.npmjs.org/jsonc-parser/-/jsonc-parser-3.2.1.tgz", + "integrity": "sha512-AilxAyFOAcK5wA1+LeaySVBrHsGQvUFCDWXKpZjzaL0PqW+xfBOttn8GNtWKFWqneyMZj41MWF9Kl6iPWLwgOA==", + "dev": true + }, + "path-type": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/path-type/-/path-type-5.0.0.tgz", + "integrity": "sha512-5HviZNaZcfqP95rwpv+1HDgUamezbqdSYTyzjTvwtJSnIH+3vnbmWsItli8OFEndS984VT55M3jduxZbX351gg==", + "dev": true + }, + "slash": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/slash/-/slash-5.1.0.tgz", + "integrity": "sha512-ZA6oR3T/pEyuqwMgAKT0/hAv8oAXckzbkmR0UkUosQ+Mc4RxGoJkRmwHgHufaenlyAgE1Mxgpdcrf75y6XcnDg==", + "dev": true + } + } + }, + "markdownlint-cli2-formatter-default": { + "version": "0.0.4", + "resolved": "https://registry.npmjs.org/markdownlint-cli2-formatter-default/-/markdownlint-cli2-formatter-default-0.0.4.tgz", + "integrity": "sha512-xm2rM0E+sWgjpPn1EesPXx5hIyrN2ddUnUwnbCsD/ONxYtw3PX6LydvdH6dciWAoFDpwzbHM1TO7uHfcMd6IYg==", + "dev": true, + "requires": {} + }, + "markdownlint-micromark": { + "version": "0.1.9", + "resolved": "https://registry.npmjs.org/markdownlint-micromark/-/markdownlint-micromark-0.1.9.tgz", + "integrity": "sha512-5hVs/DzAFa8XqYosbEAEg6ok6MF2smDj89ztn9pKkCtdKHVdPQuGMH7frFfYL9mLkvfFe4pTyAMffLbjf3/EyA==", + "dev": true + }, "marky": { "version": "1.2.5", "resolved": "https://registry.npmjs.org/marky/-/marky-1.2.5.tgz", @@ -60983,6 +61285,12 @@ "safe-buffer": "^5.1.2" } }, + "mdurl": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/mdurl/-/mdurl-2.0.0.tgz", + "integrity": "sha512-Lf+9+2r+Tdp5wXDXC4PcIBjTDtq4UKjCPMQhKIuzpJNW0b96kVqSwW0bT7FhRSfmAiFYgP+SCRvdrDozfh0U5w==", + "dev": true + }, "media-typer": { "version": "0.3.0", "resolved": "https://registry.npmjs.org/media-typer/-/media-typer-0.3.0.tgz", @@ -65324,6 +65632,12 @@ "integrity": "sha512-vYt7UD1U9Wg6138shLtLOvdAu+8DsC/ilFtEVHcH+wydcSpNE20AfSOduf6MkRFahL5FY7X1oU7nKVZFtfq8Fg==", "dev": true }, + "punycode.js": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/punycode.js/-/punycode.js-2.3.1.tgz", + "integrity": "sha512-uxFIHU0YlHYhDQtV4R9J6a52SLx28BCjT+4ieh7IGbgwVJWO+km431c4yRlREUAsAmt/uMjQUyQHNEPf0M39CA==", + "dev": true + }, "puppeteer-core": { "version": "22.4.1", "resolved": "https://registry.npmjs.org/puppeteer-core/-/puppeteer-core-22.4.1.tgz", @@ -69193,6 +69507,12 @@ "integrity": "sha512-xV8kqRKM+jhMvcHWUKthV9fNebIzrNy//2O9ZwWcfiBFR5f25XVZPLlEajk/sf3Ra15V92isyQqnIEXRDaZWEA==", "dev": true }, + "uc.micro": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/uc.micro/-/uc.micro-2.1.0.tgz", + "integrity": "sha512-ARDJmphmdvUk6Glw7y9DQ2bFkKBHwQHLi2lsaH6PPmz/Ka9sFOBsBluozhDltWmnv9u/cF6Rt87znRTPV+yp/A==", + "dev": true + }, "uglify-js": { "version": "3.17.4", "resolved": "https://registry.npmjs.org/uglify-js/-/uglify-js-3.17.4.tgz", @@ -69255,6 +69575,12 @@ "integrity": "sha512-JlCMO+ehdEIKqlFxk6IfVoAUVmgz7cU7zD/h9XZ0qzeosSHmUJVOzSQvvYSYWXkFXC+IfLKSIffhv0sVZup6pA==", "dev": true }, + "unicorn-magic": { + "version": "0.1.0", + "resolved": "https://registry.npmjs.org/unicorn-magic/-/unicorn-magic-0.1.0.tgz", + "integrity": "sha512-lRfVq8fE8gz6QMBuDM6a+LO3IAzTi05H6gCVaUpir2E1Rwpo4ZUog45KpNXKC/Mn3Yb9UDuHumeFTo9iV/D9FQ==", + "dev": true + }, "union-value": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/union-value/-/union-value-1.0.1.tgz", diff --git a/package.json b/package.json index 177c83d77d..0d6447f3ea 100644 --- a/package.json +++ b/package.json @@ -26,7 +26,9 @@ "lint": "lerna run lint", "lint:fix": "lerna run lint:fix", "lint:examples": "eslint ./examples/**/*.js", - "lint:examples:fix": "eslint ./examples/**/*.js --fix" + "lint:examples:fix": "eslint ./examples/**/*.js --fix", + "lint:markdown": "markdownlint-cli2 $(git ls-files '*.md')", + "lint:markdown:fix": "markdownlint-cli2 --fix $(git ls-files '*.md')" }, "keywords": [ "opentelemetry", @@ -51,6 +53,7 @@ "glob": "^10.3.10", "lerna": "6.6.2", "lerna-changelog": "2.2.0", + "markdownlint-cli2": "0.13.0", "minimatch": "^9.0.3", "prettier": "2.8.8", "semver": "^7.6.0", diff --git a/plugins/node/opentelemetry-instrumentation-nestjs-core/README.md b/plugins/node/opentelemetry-instrumentation-nestjs-core/README.md index ac24133fa3..ba54f30230 100644 --- a/plugins/node/opentelemetry-instrumentation-nestjs-core/README.md +++ b/plugins/node/opentelemetry-instrumentation-nestjs-core/README.md @@ -83,6 +83,4 @@ Apache 2.0 - See [LICENSE][license-url] for more information. [license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat [npm-url]: https://www.npmjs.com/package/@opentelemetry/instrumentation-nestjs-core [npm-img]: https://badge.fury.io/js/%40opentelemetry%2Finstrumentation-nestjs-core.svg -[pkg-repo-url]: https://github.com/nestjs/nest -[pkg-npm-url]: https://www.npmjs.com/package/@nestjs/core [pkg-web-url]: https://nestjs.com/ From 4733ea4b037d0eb80ed0723414d9648a32423ba8 Mon Sep 17 00:00:00 2001 From: Trent Mick Date: Wed, 22 May 2024 17:15:07 -0700 Subject: [PATCH 2/8] remove errant Dependencies sections from the top of some changelog files found by rule MD001 (see #2207) --- .../CHANGELOG.md | 72 --------- .../CHANGELOG.md | 66 -------- .../CHANGELOG.md | 12 -- .../CHANGELOG.md | 60 ------- .../CHANGELOG.md | 60 ------- .../CHANGELOG.md | 6 - .../auto-instrumentations-node/CHANGELOG.md | 152 ------------------ .../auto-instrumentations-web/CHANGELOG.md | 12 -- .../CHANGELOG.md | 60 ------- .../node/instrumentation-amqplib/CHANGELOG.md | 6 - .../instrumentation-lru-memoizer/CHANGELOG.md | 6 - .../instrumentation-mongoose/CHANGELOG.md | 6 - .../instrumentation-socket.io/CHANGELOG.md | 6 - .../node/instrumentation-tedious/CHANGELOG.md | 6 - .../CHANGELOG.md | 6 - .../CHANGELOG.md | 6 - .../CHANGELOG.md | 6 - .../CHANGELOG.md | 6 - .../CHANGELOG.md | 6 - .../CHANGELOG.md | 6 - .../CHANGELOG.md | 12 -- .../CHANGELOG.md | 12 -- 22 files changed, 590 deletions(-) diff --git a/detectors/node/opentelemetry-resource-detector-alibaba-cloud/CHANGELOG.md b/detectors/node/opentelemetry-resource-detector-alibaba-cloud/CHANGELOG.md index ae374d98a6..f4c4e77262 100644 --- a/detectors/node/opentelemetry-resource-detector-alibaba-cloud/CHANGELOG.md +++ b/detectors/node/opentelemetry-resource-detector-alibaba-cloud/CHANGELOG.md @@ -1,77 +1,5 @@ # Changelog -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.30.0 to ^0.31.0 - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.31.0 to ^0.32.0 - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.32.0 to ^0.33.0 - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.33.0 to ^0.33.1 - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.33.1 to ^0.33.2 - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.33.3 to ^0.33.4 - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.34.1 to ^0.34.2 - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.34.2 to ^0.34.3 - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.34.3 to ^0.35.0 - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.35.0 to ^0.35.1 - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.35.1 to ^0.36.0 - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.36.0 to ^0.37.0 - ## [0.28.9](https://github.com/open-telemetry/opentelemetry-js-contrib/compare/resource-detector-alibaba-cloud-v0.28.8...resource-detector-alibaba-cloud-v0.28.9) (2024-04-25) diff --git a/detectors/node/opentelemetry-resource-detector-aws/CHANGELOG.md b/detectors/node/opentelemetry-resource-detector-aws/CHANGELOG.md index d824077ae8..682e603558 100644 --- a/detectors/node/opentelemetry-resource-detector-aws/CHANGELOG.md +++ b/detectors/node/opentelemetry-resource-detector-aws/CHANGELOG.md @@ -1,71 +1,5 @@ # Changelog -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.30.0 to ^0.31.0 - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.31.0 to ^0.32.0 - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.32.0 to ^0.33.0 - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.33.0 to ^0.33.1 - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.33.1 to ^0.33.2 - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.33.3 to ^0.33.4 - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.34.1 to ^0.34.2 - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.34.2 to ^0.34.3 - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.34.3 to ^0.35.0 - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.35.0 to ^0.35.1 - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.35.1 to ^0.36.0 - ## [1.5.0](https://github.com/open-telemetry/opentelemetry-js-contrib/compare/resource-detector-aws-v1.4.2...resource-detector-aws-v1.5.0) (2024-05-15) diff --git a/detectors/node/opentelemetry-resource-detector-azure/CHANGELOG.md b/detectors/node/opentelemetry-resource-detector-azure/CHANGELOG.md index 37556413cb..bc3b8cc98b 100644 --- a/detectors/node/opentelemetry-resource-detector-azure/CHANGELOG.md +++ b/detectors/node/opentelemetry-resource-detector-azure/CHANGELOG.md @@ -1,17 +1,5 @@ # Changelog -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.35.1 to ^0.36.0 - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.36.0 to ^0.37.0 - ## [0.2.7](https://github.com/open-telemetry/opentelemetry-js-contrib/compare/resource-detector-azure-v0.2.6...resource-detector-azure-v0.2.7) (2024-04-25) diff --git a/detectors/node/opentelemetry-resource-detector-container/CHANGELOG.md b/detectors/node/opentelemetry-resource-detector-container/CHANGELOG.md index 36aa20bfa8..6f692273fd 100644 --- a/detectors/node/opentelemetry-resource-detector-container/CHANGELOG.md +++ b/detectors/node/opentelemetry-resource-detector-container/CHANGELOG.md @@ -1,65 +1,5 @@ # Changelog -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.30.0 to ^0.31.0 - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.32.0 to ^0.33.0 - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.33.0 to ^0.33.1 - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.33.1 to ^0.33.2 - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.33.3 to ^0.33.4 - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.34.2 to ^0.34.3 - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.34.3 to ^0.35.0 - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.35.0 to ^0.35.1 - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.35.1 to ^0.36.0 - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.36.0 to ^0.37.0 - ## [0.3.9](https://github.com/open-telemetry/opentelemetry-js-contrib/compare/resource-detector-container-v0.3.8...resource-detector-container-v0.3.9) (2024-04-25) diff --git a/detectors/node/opentelemetry-resource-detector-gcp/CHANGELOG.md b/detectors/node/opentelemetry-resource-detector-gcp/CHANGELOG.md index 6037084fb9..b36d6b026a 100644 --- a/detectors/node/opentelemetry-resource-detector-gcp/CHANGELOG.md +++ b/detectors/node/opentelemetry-resource-detector-gcp/CHANGELOG.md @@ -1,65 +1,5 @@ # Changelog -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.30.0 to ^0.31.0 - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.31.0 to ^0.32.0 - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.32.0 to ^0.33.0 - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.33.0 to ^0.33.1 - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.33.1 to ^0.33.2 - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.33.3 to ^0.33.4 - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.34.3 to ^0.35.0 - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.35.0 to ^0.35.1 - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.35.1 to ^0.36.0 - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.36.0 to ^0.37.0 - ## [0.29.9](https://github.com/open-telemetry/opentelemetry-js-contrib/compare/resource-detector-gcp-v0.29.8...resource-detector-gcp-v0.29.9) (2024-04-25) diff --git a/detectors/node/opentelemetry-resource-detector-instana/CHANGELOG.md b/detectors/node/opentelemetry-resource-detector-instana/CHANGELOG.md index 8e06bd069d..fc9f94df52 100644 --- a/detectors/node/opentelemetry-resource-detector-instana/CHANGELOG.md +++ b/detectors/node/opentelemetry-resource-detector-instana/CHANGELOG.md @@ -1,11 +1,5 @@ # Changelog -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.34.3 to ^0.35.0 - ## [0.9.0](https://github.com/open-telemetry/opentelemetry-js-contrib/compare/resource-detector-instana-v0.8.0...resource-detector-instana-v0.9.0) (2024-04-25) diff --git a/metapackages/auto-instrumentations-node/CHANGELOG.md b/metapackages/auto-instrumentations-node/CHANGELOG.md index c41024c926..d84abc9296 100644 --- a/metapackages/auto-instrumentations-node/CHANGELOG.md +++ b/metapackages/auto-instrumentations-node/CHANGELOG.md @@ -1,157 +1,5 @@ # Changelog -### Dependencies - -* The following workspace dependencies were updated - * dependencies - * @opentelemetry/instrumentation-aws-sdk bumped from ^0.5.0 to ^0.5.1 - * @opentelemetry/instrumentation-fastify bumped from ^0.25.0 to ^0.26.0 - * @opentelemetry/instrumentation-graphql bumped from ^0.27.3 to ^0.27.4 - * @opentelemetry/instrumentation-ioredis bumped from ^0.27.1 to ^0.28.0 - * @opentelemetry/instrumentation-mongodb bumped from ^0.28.0 to ^0.29.0 - * @opentelemetry/instrumentation-mysql bumped from ^0.27.1 to ^0.28.0 - * @opentelemetry/instrumentation-mysql2 bumped from ^0.28.0 to ^0.29.0 - * @opentelemetry/instrumentation-redis bumped from ^0.28.0 to ^0.29.0 - * @opentelemetry/instrumentation-winston bumped from ^0.27.0 to ^0.27.2 - -### Dependencies - -* The following workspace dependencies were updated - * dependencies - * @opentelemetry/instrumentation-aws-sdk bumped from ^0.8.0 to ^0.8.1 - * @opentelemetry/instrumentation-ioredis bumped from ^0.30.0 to ^0.31.0 - -### Dependencies - -* The following workspace dependencies were updated - * dependencies - * @opentelemetry/instrumentation-cassandra-driver bumped from ^0.29.0 to ^0.29.1 - * @opentelemetry/instrumentation-knex bumped from ^0.29.0 to ^0.29.1 - * @opentelemetry/instrumentation-koa bumped from ^0.30.0 to ^0.31.0 - * @opentelemetry/instrumentation-lru-memoizer bumped from ^0.29.0 to ^0.30.0 - * @opentelemetry/instrumentation-mongodb bumped from ^0.31.0 to ^0.31.1 - * @opentelemetry/instrumentation-mysql2 bumped from ^0.31.0 to ^0.31.1 - -### Dependencies - -* The following workspace dependencies were updated - * dependencies - * @opentelemetry/instrumentation-aws-sdk bumped from ^0.9.0 to ^0.9.1 - * @opentelemetry/instrumentation-express bumped from ^0.31.0 to ^0.31.1 - * @opentelemetry/instrumentation-graphql bumped from ^0.30.0 to ^0.31.0 - * @opentelemetry/instrumentation-ioredis bumped from ^0.32.0 to ^0.32.1 - * @opentelemetry/instrumentation-mysql bumped from ^0.31.0 to ^0.31.1 - * @opentelemetry/instrumentation-net bumped from ^0.30.0 to ^0.30.1 - * @opentelemetry/instrumentation-pg bumped from ^0.31.0 to ^0.31.1 - * @opentelemetry/instrumentation-pino bumped from ^0.31.0 to ^0.32.0 - * @opentelemetry/instrumentation-redis-4 bumped from ^0.32.0 to ^0.33.0 - -### Dependencies - -* The following workspace dependencies were updated - * dependencies - * @opentelemetry/instrumentation-express bumped from ^0.31.1 to ^0.31.2 - -### Dependencies - -* The following workspace dependencies were updated - * dependencies - * @opentelemetry/instrumentation-aws-lambda bumped from ^0.34.1 to ^0.35.0 - -### Dependencies - -* The following workspace dependencies were updated - * dependencies - * @opentelemetry/instrumentation-amqplib bumped from ^0.32.1 to ^0.32.2 - * @opentelemetry/instrumentation-dataloader bumped from ^0.3.1 to ^0.4.0 - * @opentelemetry/instrumentation-dns bumped from ^0.31.1 to ^0.31.2 - * @opentelemetry/instrumentation-nestjs-core bumped from ^0.32.1 to ^0.32.2 - -### Dependencies - -* The following workspace dependencies were updated - * dependencies - * @opentelemetry/instrumentation-fs bumped from ^0.7.0 to ^0.7.1 - * @opentelemetry/instrumentation-graphql bumped from ^0.33.1 to ^0.33.2 - * @opentelemetry/instrumentation-ioredis bumped from ^0.33.2 to ^0.34.0 - * @opentelemetry/instrumentation-koa bumped from ^0.34.1 to ^0.34.2 - * @opentelemetry/instrumentation-pg bumped from ^0.34.1 to ^0.35.0 - * @opentelemetry/instrumentation-redis bumped from ^0.34.2 to ^0.34.3 - * @opentelemetry/instrumentation-redis-4 bumped from ^0.34.2 to ^0.34.3 - -### Dependencies - -* The following workspace dependencies were updated - * dependencies - * @opentelemetry/instrumentation-graphql bumped from ^0.33.2 to ^0.34.0 - * @opentelemetry/instrumentation-koa bumped from ^0.34.2 to ^0.34.3 - * @opentelemetry/instrumentation-redis bumped from ^0.34.3 to ^0.34.4 - -### Dependencies - -* The following workspace dependencies were updated - * dependencies - * @opentelemetry/instrumentation-generic-pool bumped from ^0.32.1 to ^0.32.2 - -### Dependencies - -* The following workspace dependencies were updated - * dependencies - * @opentelemetry/instrumentation-dns bumped from ^0.32.1 to ^0.32.2 - * @opentelemetry/instrumentation-fastify bumped from ^0.32.1 to ^0.32.2 - * @opentelemetry/instrumentation-mongodb bumped from ^0.36.1 to ^0.37.0 - -### Dependencies - -* The following workspace dependencies were updated - * dependencies - * @opentelemetry/instrumentation-redis-4 bumped from ^0.35.2 to ^0.35.3 - -### Dependencies - -* The following workspace dependencies were updated - * dependencies - * @opentelemetry/instrumentation-amqplib bumped from ^0.33.3 to ^0.33.4 - * @opentelemetry/instrumentation-aws-sdk bumped from ^0.36.2 to ^0.37.0 - * @opentelemetry/instrumentation-cassandra-driver bumped from ^0.34.0 to ^0.34.1 - * @opentelemetry/instrumentation-ioredis bumped from ^0.35.3 to ^0.36.0 - * @opentelemetry/instrumentation-lru-memoizer bumped from ^0.33.3 to ^0.33.4 - * @opentelemetry/instrumentation-memcached bumped from ^0.32.3 to ^0.32.4 - * @opentelemetry/instrumentation-mongodb bumped from ^0.37.2 to ^0.37.3 - * @opentelemetry/instrumentation-mongoose bumped from ^0.33.3 to ^0.33.4 - * @opentelemetry/instrumentation-mysql bumped from ^0.34.3 to ^0.34.4 - * @opentelemetry/instrumentation-mysql2 bumped from ^0.34.3 to ^0.34.4 - * @opentelemetry/instrumentation-pg bumped from ^0.37.0 to ^0.37.1 - * @opentelemetry/instrumentation-redis bumped from ^0.35.3 to ^0.35.4 - * @opentelemetry/instrumentation-redis-4 bumped from ^0.35.4 to ^0.35.5 - * @opentelemetry/instrumentation-socket.io bumped from ^0.34.3 to ^0.34.4 - * @opentelemetry/instrumentation-tedious bumped from ^0.6.3 to ^0.6.4 - * @opentelemetry/resource-detector-alibaba-cloud bumped from ^0.28.3 to ^0.28.4 - * @opentelemetry/resource-detector-aws bumped from ^1.3.3 to ^1.3.4 - * @opentelemetry/resource-detector-container bumped from ^0.3.3 to ^0.3.4 - * @opentelemetry/resource-detector-gcp bumped from ^0.29.3 to ^0.29.4 - -### Dependencies - -* The following workspace dependencies were updated - * dependencies - * @opentelemetry/instrumentation-aws-lambda bumped from ^0.37.2 to ^0.37.3 - * @opentelemetry/instrumentation-aws-sdk bumped from ^0.37.0 to ^0.37.1 - * @opentelemetry/instrumentation-bunyan bumped from ^0.33.0 to ^0.34.0 - * @opentelemetry/instrumentation-cucumber bumped from ^0.1.2 to ^0.2.0 - * @opentelemetry/instrumentation-express bumped from ^0.33.3 to ^0.34.0 - * @opentelemetry/instrumentation-fastify bumped from ^0.32.4 to ^0.32.5 - * @opentelemetry/instrumentation-koa bumped from ^0.36.2 to ^0.36.3 - * @opentelemetry/instrumentation-mongodb bumped from ^0.37.3 to ^0.38.0 - * @opentelemetry/instrumentation-net bumped from ^0.32.3 to ^0.32.4 - * @opentelemetry/instrumentation-pino bumped from ^0.34.3 to ^0.34.4 - -### Dependencies - -* The following workspace dependencies were updated - * dependencies - * @opentelemetry/instrumentation-aws-sdk bumped from ^0.38.0 to ^0.38.1 - ## [0.46.1](https://github.com/open-telemetry/opentelemetry-js-contrib/compare/auto-instrumentations-node-v0.46.0...auto-instrumentations-node-v0.46.1) (2024-05-15) diff --git a/metapackages/auto-instrumentations-web/CHANGELOG.md b/metapackages/auto-instrumentations-web/CHANGELOG.md index 94fc875089..d85a840680 100644 --- a/metapackages/auto-instrumentations-web/CHANGELOG.md +++ b/metapackages/auto-instrumentations-web/CHANGELOG.md @@ -1,17 +1,5 @@ # Changelog -### Dependencies - -* The following workspace dependencies were updated - * dependencies - * @opentelemetry/instrumentation-user-interaction bumped from ^0.30.0 to ^0.30.1 - -### Dependencies - -* The following workspace dependencies were updated - * dependencies - * @opentelemetry/instrumentation-document-load bumped from ^0.31.1 to ^0.31.2 - ## [0.39.0](https://github.com/open-telemetry/opentelemetry-js-contrib/compare/auto-instrumentations-web-v0.38.0...auto-instrumentations-web-v0.39.0) (2024-04-25) diff --git a/packages/opentelemetry-propagation-utils/CHANGELOG.md b/packages/opentelemetry-propagation-utils/CHANGELOG.md index 0b233f0097..645dc6e294 100644 --- a/packages/opentelemetry-propagation-utils/CHANGELOG.md +++ b/packages/opentelemetry-propagation-utils/CHANGELOG.md @@ -1,65 +1,5 @@ # Changelog -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.31.0 to ^0.33.0 - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.33.0 to ^0.33.1 - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.33.1 to ^0.33.2 - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.33.3 to ^0.33.4 - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.34.1 to ^0.34.2 - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.34.2 to ^0.34.3 - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.34.3 to ^0.35.0 - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.35.0 to ^0.35.1 - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.35.1 to ^0.36.0 - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.36.0 to ^0.37.0 - ## [0.30.9](https://github.com/open-telemetry/opentelemetry-js-contrib/compare/propagation-utils-v0.30.8...propagation-utils-v0.30.9) (2024-04-25) diff --git a/plugins/node/instrumentation-amqplib/CHANGELOG.md b/plugins/node/instrumentation-amqplib/CHANGELOG.md index abe7b56fcc..a178b7ceb8 100644 --- a/plugins/node/instrumentation-amqplib/CHANGELOG.md +++ b/plugins/node/instrumentation-amqplib/CHANGELOG.md @@ -1,11 +1,5 @@ # Changelog -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.34.3 to ^0.35.0 - ## [0.37.0](https://github.com/open-telemetry/opentelemetry-js-contrib/compare/instrumentation-amqplib-v0.36.0...instrumentation-amqplib-v0.37.0) (2024-04-25) diff --git a/plugins/node/instrumentation-lru-memoizer/CHANGELOG.md b/plugins/node/instrumentation-lru-memoizer/CHANGELOG.md index 0894302e84..e7d4223e41 100644 --- a/plugins/node/instrumentation-lru-memoizer/CHANGELOG.md +++ b/plugins/node/instrumentation-lru-memoizer/CHANGELOG.md @@ -1,11 +1,5 @@ # Changelog -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.34.3 to ^0.35.0 - ## [0.37.0](https://github.com/open-telemetry/opentelemetry-js-contrib/compare/instrumentation-lru-memoizer-v0.36.0...instrumentation-lru-memoizer-v0.37.0) (2024-04-25) diff --git a/plugins/node/instrumentation-mongoose/CHANGELOG.md b/plugins/node/instrumentation-mongoose/CHANGELOG.md index 3ecd94b550..3e8d038e5b 100644 --- a/plugins/node/instrumentation-mongoose/CHANGELOG.md +++ b/plugins/node/instrumentation-mongoose/CHANGELOG.md @@ -1,11 +1,5 @@ # Changelog -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.34.3 to ^0.35.0 - ## [0.38.1](https://github.com/open-telemetry/opentelemetry-js-contrib/compare/instrumentation-mongoose-v0.38.0...instrumentation-mongoose-v0.38.1) (2024-05-02) diff --git a/plugins/node/instrumentation-socket.io/CHANGELOG.md b/plugins/node/instrumentation-socket.io/CHANGELOG.md index ff649a2854..d3512ebc7c 100644 --- a/plugins/node/instrumentation-socket.io/CHANGELOG.md +++ b/plugins/node/instrumentation-socket.io/CHANGELOG.md @@ -1,11 +1,5 @@ # Changelog -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.34.3 to ^0.35.0 - ## [0.39.0](https://github.com/open-telemetry/opentelemetry-js-contrib/compare/instrumentation-socket.io-v0.38.0...instrumentation-socket.io-v0.39.0) (2024-04-25) diff --git a/plugins/node/instrumentation-tedious/CHANGELOG.md b/plugins/node/instrumentation-tedious/CHANGELOG.md index 455ad22ac5..05bbb10992 100644 --- a/plugins/node/instrumentation-tedious/CHANGELOG.md +++ b/plugins/node/instrumentation-tedious/CHANGELOG.md @@ -1,11 +1,5 @@ # Changelog -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.34.3 to ^0.35.0 - ## [0.10.1](https://github.com/open-telemetry/opentelemetry-js-contrib/compare/instrumentation-tedious-v0.10.0...instrumentation-tedious-v0.10.1) (2024-05-02) diff --git a/plugins/node/opentelemetry-instrumentation-cassandra/CHANGELOG.md b/plugins/node/opentelemetry-instrumentation-cassandra/CHANGELOG.md index 8f9bcdec60..0005177884 100644 --- a/plugins/node/opentelemetry-instrumentation-cassandra/CHANGELOG.md +++ b/plugins/node/opentelemetry-instrumentation-cassandra/CHANGELOG.md @@ -1,11 +1,5 @@ # Changelog -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.34.3 to ^0.35.0 - ## [0.38.0](https://github.com/open-telemetry/opentelemetry-js-contrib/compare/instrumentation-cassandra-driver-v0.37.0...instrumentation-cassandra-driver-v0.38.0) (2024-04-25) diff --git a/plugins/node/opentelemetry-instrumentation-memcached/CHANGELOG.md b/plugins/node/opentelemetry-instrumentation-memcached/CHANGELOG.md index a33c58408f..719c6e0b56 100644 --- a/plugins/node/opentelemetry-instrumentation-memcached/CHANGELOG.md +++ b/plugins/node/opentelemetry-instrumentation-memcached/CHANGELOG.md @@ -1,11 +1,5 @@ # Changelog -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.34.3 to ^0.35.0 - ## [0.36.0](https://github.com/open-telemetry/opentelemetry-js-contrib/compare/instrumentation-memcached-v0.35.0...instrumentation-memcached-v0.36.0) (2024-04-25) diff --git a/plugins/node/opentelemetry-instrumentation-mongodb/CHANGELOG.md b/plugins/node/opentelemetry-instrumentation-mongodb/CHANGELOG.md index 2357e2c607..6890eb6781 100644 --- a/plugins/node/opentelemetry-instrumentation-mongodb/CHANGELOG.md +++ b/plugins/node/opentelemetry-instrumentation-mongodb/CHANGELOG.md @@ -1,11 +1,5 @@ # Changelog -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.34.3 to ^0.35.0 - ## [0.43.0](https://github.com/open-telemetry/opentelemetry-js-contrib/compare/instrumentation-mongodb-v0.42.0...instrumentation-mongodb-v0.43.0) (2024-04-25) diff --git a/plugins/node/opentelemetry-instrumentation-mysql/CHANGELOG.md b/plugins/node/opentelemetry-instrumentation-mysql/CHANGELOG.md index 8ca1ed7f1e..72f1728245 100644 --- a/plugins/node/opentelemetry-instrumentation-mysql/CHANGELOG.md +++ b/plugins/node/opentelemetry-instrumentation-mysql/CHANGELOG.md @@ -1,11 +1,5 @@ # Changelog -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.34.3 to ^0.35.0 - ## [0.38.1](https://github.com/open-telemetry/opentelemetry-js-contrib/compare/instrumentation-mysql-v0.38.0...instrumentation-mysql-v0.38.1) (2024-05-02) diff --git a/plugins/node/opentelemetry-instrumentation-mysql2/CHANGELOG.md b/plugins/node/opentelemetry-instrumentation-mysql2/CHANGELOG.md index 54125f5ba2..a8dbdd6431 100644 --- a/plugins/node/opentelemetry-instrumentation-mysql2/CHANGELOG.md +++ b/plugins/node/opentelemetry-instrumentation-mysql2/CHANGELOG.md @@ -1,11 +1,5 @@ # Changelog -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.34.3 to ^0.35.0 - ## [0.38.1](https://github.com/open-telemetry/opentelemetry-js-contrib/compare/instrumentation-mysql2-v0.38.0...instrumentation-mysql2-v0.38.1) (2024-05-02) diff --git a/plugins/node/opentelemetry-instrumentation-pg/CHANGELOG.md b/plugins/node/opentelemetry-instrumentation-pg/CHANGELOG.md index ff4aaae86e..0fc8bd96f8 100644 --- a/plugins/node/opentelemetry-instrumentation-pg/CHANGELOG.md +++ b/plugins/node/opentelemetry-instrumentation-pg/CHANGELOG.md @@ -1,11 +1,5 @@ # Changelog -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.34.3 to ^0.35.0 - ## [0.41.0](https://github.com/open-telemetry/opentelemetry-js-contrib/compare/instrumentation-pg-v0.40.0...instrumentation-pg-v0.41.0) (2024-04-25) diff --git a/plugins/node/opentelemetry-instrumentation-redis-4/CHANGELOG.md b/plugins/node/opentelemetry-instrumentation-redis-4/CHANGELOG.md index 6a8dfd06b8..02880ab527 100644 --- a/plugins/node/opentelemetry-instrumentation-redis-4/CHANGELOG.md +++ b/plugins/node/opentelemetry-instrumentation-redis-4/CHANGELOG.md @@ -1,17 +1,5 @@ # Changelog -### Dependencies - -* The following workspace dependencies were updated - * dependencies - * @opentelemetry/redis-common bumped from ^0.34.0 to ^0.35.0 - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.34.3 to ^0.35.0 - ## [0.39.0](https://github.com/open-telemetry/opentelemetry-js-contrib/compare/instrumentation-redis-4-v0.38.0...instrumentation-redis-4-v0.39.0) (2024-04-25) diff --git a/plugins/node/opentelemetry-instrumentation-redis/CHANGELOG.md b/plugins/node/opentelemetry-instrumentation-redis/CHANGELOG.md index cd856dc0a7..ca04cca227 100644 --- a/plugins/node/opentelemetry-instrumentation-redis/CHANGELOG.md +++ b/plugins/node/opentelemetry-instrumentation-redis/CHANGELOG.md @@ -1,17 +1,5 @@ # Changelog -### Dependencies - -* The following workspace dependencies were updated - * dependencies - * @opentelemetry/redis-common bumped from ^0.34.0 to ^0.35.0 - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.34.3 to ^0.35.0 - ## [0.39.1](https://github.com/open-telemetry/opentelemetry-js-contrib/compare/instrumentation-redis-v0.39.0...instrumentation-redis-v0.39.1) (2024-05-02) From c5233da3ebaa3f7e16460360abf806b5427501fd Mon Sep 17 00:00:00 2001 From: Trent Mick Date: Wed, 22 May 2024 17:15:20 -0700 Subject: [PATCH 3/8] disable markdown lint for the old, unused, top-level CHANGELOG.md --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index f288a54e4d..085bec8608 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,4 @@ + # CHANGELOG As of v0.25.1 (2022-01-24) changelog content has moved to separate CHANGELOG.md files for each package. Use [this search for a list of all CHANGELOG.md files in this repo](https://github.com/search?q=repo%3Aopen-telemetry%2Fopentelemetry-js-contrib+path%3A**%2FCHANGELOG.md&type=code). From 1d35785814571e1a59856025386d504100f8e54f Mon Sep 17 00:00:00 2001 From: Trent Mick Date: Wed, 22 May 2024 17:29:17 -0700 Subject: [PATCH 4/8] manually work through markdown lint errors --- CONTRIBUTING.md | 2 +- .../CHANGELOG.md | 2 +- .../opentelemetry-resource-detector-azure/README.md | 10 ++++++++++ .../README.md | 2 ++ .../opentelemetry-id-generator-aws-xray/README.md | 11 ++++++----- plugins/node/instrumentation-amqplib/README.md | 2 +- .../opentelemetry-instrumentation-aws-sdk/README.md | 2 +- .../node/opentelemetry-instrumentation-dns/README.md | 2 +- .../opentelemetry-instrumentation-graphql/README.md | 12 ++++++------ .../opentelemetry-instrumentation-mysql/README.md | 2 +- .../README.md | 10 +++++----- 11 files changed, 35 insertions(+), 22 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f05cf8e937..6e014f3ee1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -150,7 +150,7 @@ With the exception of the stable status, it is up to each individual [component A component may only be marked stable with the approval of a member of @open-telemetry/javascript-maintainers; see the definition of stable below for more details. A Pull Request modifying components in any stage of the lifecycle is subject to the -[Pull Request Merge Requirements](#pull-request-merge-requirements). +[Pull Request Merge Guidelines](#pull-request-merge-guidelines). ### Unreleased diff --git a/detectors/node/opentelemetry-resource-detector-azure/CHANGELOG.md b/detectors/node/opentelemetry-resource-detector-azure/CHANGELOG.md index bc3b8cc98b..9e09232989 100644 --- a/detectors/node/opentelemetry-resource-detector-azure/CHANGELOG.md +++ b/detectors/node/opentelemetry-resource-detector-azure/CHANGELOG.md @@ -72,7 +72,7 @@ * devDependencies * @opentelemetry/contrib-test-utils bumped from ^0.34.1 to ^0.34.3 -## [0.1.0]() () +## 0.1.0 ### Features diff --git a/detectors/node/opentelemetry-resource-detector-azure/README.md b/detectors/node/opentelemetry-resource-detector-azure/README.md index c900a48663..4b7ff90938 100644 --- a/detectors/node/opentelemetry-resource-detector-azure/README.md +++ b/detectors/node/opentelemetry-resource-detector-azure/README.md @@ -75,3 +75,13 @@ This package implements Semantic Convention [Version 1.19.0](https://github.com/ - For more information on OpenTelemetry, visit: - For more about OpenTelemetry JavaScript: - For help or feedback on this project, join us in [GitHub Discussions][discussions-url] + +## License + +Apache 2.0 - See [LICENSE][license-url] for more information. + +[discussions-url]: https://github.com/open-telemetry/opentelemetry-js/discussions +[license-url]: https://github.com/open-telemetry/opentelemetry-js-contrib/blob/main/LICENSE +[license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat +[npm-url]: https://www.npmjs.com/package/@opentelemetry/resource-detector-azure +[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fresource-detector-azure.svg diff --git a/detectors/node/opentelemetry-resource-detector-container/README.md b/detectors/node/opentelemetry-resource-detector-container/README.md index f798241a28..fd452420fe 100644 --- a/detectors/node/opentelemetry-resource-detector-container/README.md +++ b/detectors/node/opentelemetry-resource-detector-container/README.md @@ -51,3 +51,5 @@ Apache 2.0 - See [LICENSE][license-url] for more information. [discussions-url]: https://github.com/open-telemetry/opentelemetry-js/discussions [license-url]: https://github.com/open-telemetry/opentelemetry-js-contrib/blob/main/LICENSE [license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat +[npm-url]: https://www.npmjs.com/package/@opentelemetry/resource-detector-container +[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fresource-detector-container.svg diff --git a/packages/opentelemetry-id-generator-aws-xray/README.md b/packages/opentelemetry-id-generator-aws-xray/README.md index 707cddadbb..8c7d77604d 100644 --- a/packages/opentelemetry-id-generator-aws-xray/README.md +++ b/packages/opentelemetry-id-generator-aws-xray/README.md @@ -53,8 +53,9 @@ A trace ID consists of two parts: ## License Apache 2.0 - See [LICENSE][license-url] for more information. -[discussions-url]: -[license-url]: -[license-image]: -[npm-url]: -[npm-img]: + +[discussions-url]: https://github.com/open-telemetry/opentelemetry-js/discussions +[license-url]: https://github.com/open-telemetry/opentelemetry-js-contrib/blob/main/LICENSE +[license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat +[npm-url]: https://www.npmjs.com/package/@opentelemetry/id-generator-aws-xray +[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fid-generator-aws-xray.svg diff --git a/plugins/node/instrumentation-amqplib/README.md b/plugins/node/instrumentation-amqplib/README.md index 5d4933db7e..1fce886b89 100644 --- a/plugins/node/instrumentation-amqplib/README.md +++ b/plugins/node/instrumentation-amqplib/README.md @@ -55,7 +55,7 @@ amqplib instrumentation has few options available to choose from. You can set th | `publishConfirmHook` | `AmqplibPublishConfirmCustomAttributeFunction` | hook for adding custom attributes after publish message is confirmed by the broker. | | `consumeHook` | `AmqplibConsumeCustomAttributeFunction` | hook for adding custom attributes before consumer message is processed. | | `consumeEndHook` | `AmqplibConsumeEndCustomAttributeFunction` | hook for adding custom attributes after consumer message is acked to server. | -| `consumeTimeoutMs` | `number` | read [Consume Timeout](#ConsumeTimeout) below | +| `consumeTimeoutMs` | `number` | read [Consume Timeout](#consume-timeout) below | ### Consume Timeout diff --git a/plugins/node/opentelemetry-instrumentation-aws-sdk/README.md b/plugins/node/opentelemetry-instrumentation-aws-sdk/README.md index dc362c6a29..52017e7497 100644 --- a/plugins/node/opentelemetry-instrumentation-aws-sdk/README.md +++ b/plugins/node/opentelemetry-instrumentation-aws-sdk/README.md @@ -56,7 +56,7 @@ aws-sdk instrumentation has few options available to choose from. You can set th Both V2 and V3 instrumentations are collecting the following attributes: | Attribute Name | Type | Description | Example | | -------------- | ---- | ----------- | ------- | -| `rpc.system` | string | Always equals "aws-api" | +| `rpc.system` | string | Always equals "aws-api" | | | `rpc.method` | string | he name of the operation corresponding to the request, as returned by the AWS SDK. If the SDK does not provide a way to retrieve a name, the name of the command SHOULD be used, removing the suffix `Command` if present, resulting in a PascalCase name with no spaces. | `PutObject` | | `rpc.service` | string | The name of the service to which a request is made, as returned by the AWS SDK. If the SDK does not provide a away to retrieve a name, the name of the SDK's client interface for a service SHOULD be used, removing the suffix `Client` if present, resulting in a PascalCase name with no spaces. | `S3`, `DynamoDB`, `Route53` | | `aws.region` | string | Region name for the request | "eu-west-1" | diff --git a/plugins/node/opentelemetry-instrumentation-dns/README.md b/plugins/node/opentelemetry-instrumentation-dns/README.md index 74d7e2a7bd..d394584264 100644 --- a/plugins/node/opentelemetry-instrumentation-dns/README.md +++ b/plugins/node/opentelemetry-instrumentation-dns/README.md @@ -44,7 +44,7 @@ DNS instrumentation has currently one option. You can set the following: | Options | Type | Description | | ------- | ---- | ----------- | -| [`ignoreHostnames`](https://github.com/open-telemetry/opentelemetry-js-contrib/blob/main/plugins/node/opentelemetry-instrumentation-dns/src/types.ts#L99) | `IgnoreMatcher | IgnoreMatcher[]` | DNS instrumentation will not trace all requests that match hostnames | +| [`ignoreHostnames`](https://github.com/open-telemetry/opentelemetry-js-contrib/blob/main/plugins/node/opentelemetry-instrumentation-dns/src/types.ts#L99) | `IgnoreMatcher \| IgnoreMatcher[]` | DNS instrumentation will not trace all requests that match hostnames | ## Semantic Conventions diff --git a/plugins/node/opentelemetry-instrumentation-graphql/README.md b/plugins/node/opentelemetry-instrumentation-graphql/README.md index 9344e8ed19..5a23f47660 100644 --- a/plugins/node/opentelemetry-instrumentation-graphql/README.md +++ b/plugins/node/opentelemetry-instrumentation-graphql/README.md @@ -52,14 +52,14 @@ registerInstrumentations({ ## Optional Parameters -| Param | type | Default Value | Description | | -|:-----------:|:-------:|:-------------:|:---------------------------------------------------------------------------------------------------------------------------------------------------------:|:-:| -| mergeItems | boolean | false | Whether to merge list items into a single element. example: `users.*.name` instead of `users.0.name`, `users.1.name` | | -| depth | number | -1 | The maximum depth of fields/resolvers to instrument. When set to 0 it will not instrument fields and resolvers. When set to -1 it will instrument all fields and resolvers. | | -| allowValues | boolean | false | When set to true it will not remove attributes values from schema source. By default all values that can be sensitive are removed and replaced with "*" | | +| Param | type | Default Value | Description | +|:-----------:|:-------:|:-------------:|:---------------------------------------------------------------------------------------------------------------------------------------------------------:| +| mergeItems | boolean | false | Whether to merge list items into a single element. example: `users.*.name` instead of `users.0.name`, `users.1.name` | +| depth | number | -1 | The maximum depth of fields/resolvers to instrument. When set to 0 it will not instrument fields and resolvers. When set to -1 it will instrument all fields and resolvers. | +| allowValues | boolean | false | When set to true it will not remove attributes values from schema source. By default all values that can be sensitive are removed and replaced with "*" | | ignoreTrivialResolveSpans | boolean | false | Don't create spans for the execution of the default resolver on object properties. | | ignoreResolveSpans | boolean | false | Don't create spans for resolvers, regardless if they are trivial or not. | -| responseHook | GraphQLInstrumentationExecutionResponseHook | undefined | Hook that allows adding custom span attributes based on the data returned from "execute" GraphQL action. | | +| responseHook | GraphQLInstrumentationExecutionResponseHook | undefined | Hook that allows adding custom span attributes based on the data returned from "execute" GraphQL action. | ## Verbosity diff --git a/plugins/node/opentelemetry-instrumentation-mysql/README.md b/plugins/node/opentelemetry-instrumentation-mysql/README.md index e632521fb6..971fc5351a 100644 --- a/plugins/node/opentelemetry-instrumentation-mysql/README.md +++ b/plugins/node/opentelemetry-instrumentation-mysql/README.md @@ -47,7 +47,7 @@ See [examples/mysql](https://github.com/open-telemetry/opentelemetry-js-contrib/ | Options | Type | Default | Description | | ------- | ---- | --------| ----------- | | [`enhancedDatabaseReporting`](./src/types.ts#L24) | `boolean` | `false` | If true, an attribute containing the query's parameters will be attached the spans generated to represent the query | -| + ## Semantic Conventions diff --git a/plugins/node/opentelemetry-instrumentation-nestjs-core/README.md b/plugins/node/opentelemetry-instrumentation-nestjs-core/README.md index ba54f30230..1c1f0cd347 100644 --- a/plugins/node/opentelemetry-instrumentation-nestjs-core/README.md +++ b/plugins/node/opentelemetry-instrumentation-nestjs-core/README.md @@ -42,11 +42,11 @@ registerInstrumentations({ ## Emitted Spans -| Name | `nestjs.type` | Description | Included attributes -| ---- | ---- | ---- | ---- -`Create Nest App` | `app_creation` | Traces the bootup for the Nest App. The `NestFactory(Static).create` call. | `nestjs.module` -`.` | `request_context` | Traces the whole request context. | `http.*`, `nestjs.callback` -`` | `handler` | Traces the work of a specific controller member function. | `nestjs.callback` +| Name | `nestjs.type` | Description | Included attributes | +| ---- | ---- | ---- | ---- | +| `Create Nest App` | `app_creation` | Traces the bootup for the Nest App. The `NestFactory(Static).create` call. | `nestjs.module` | +| `.` | `request_context` | Traces the whole request context. | `http.*`, `nestjs.callback` | +| `` | `handler` | Traces the work of a specific controller member function. | `nestjs.callback` | ## Semantic Conventions From fef57e2d71eccd83d3d58448d0b8721fcd2a0433 Mon Sep 17 00:00:00 2001 From: Trent Mick Date: Wed, 22 May 2024 17:31:24 -0700 Subject: [PATCH 5/8] re-enable the MD026/no-trailing-punctuation rule default (the core repo disables this rule) --- .markdownlint-cli2.jsonc | 1 - 1 file changed, 1 deletion(-) diff --git a/.markdownlint-cli2.jsonc b/.markdownlint-cli2.jsonc index b9cee8163a..76dadf1d2f 100644 --- a/.markdownlint-cli2.jsonc +++ b/.markdownlint-cli2.jsonc @@ -8,7 +8,6 @@ "MD041": false, "MD012": false, // no-multiple-blanks, common in CHANGELOG.md files "MD045": false, // XXX no-alt-text - "MD026": false, // XXX drop? // "MD004": { "style": "dash" } // ul-style }, "gitignore": true, From 42b1959aade6ab8337b498f22acb5ee4e44d02d7 Mon Sep 17 00:00:00 2001 From: Trent Mick Date: Wed, 22 May 2024 17:43:26 -0700 Subject: [PATCH 6/8] re-enable MD045/no-alt-text --- .markdownlint-cli2.jsonc | 5 ++--- README.md | 4 ++-- examples/connect/README.md | 2 +- examples/dns/README.md | 4 ++-- examples/express/README.md | 4 ++-- examples/fastify/README.md | 2 +- examples/hapi/README.md | 4 ++-- examples/koa/README.md | 4 ++-- examples/mongodb/README.md | 4 ++-- examples/mysql/README.md | 4 ++-- examples/react-load/preact/README.md | 18 +++++++++--------- examples/react-load/react/README.md | 20 ++++++++++---------- examples/redis/README.md | 4 ++-- 13 files changed, 39 insertions(+), 40 deletions(-) diff --git a/.markdownlint-cli2.jsonc b/.markdownlint-cli2.jsonc index 76dadf1d2f..705ed18e1b 100644 --- a/.markdownlint-cli2.jsonc +++ b/.markdownlint-cli2.jsonc @@ -6,9 +6,8 @@ "MD024": false, "MD033": false, "MD041": false, - "MD012": false, // no-multiple-blanks, common in CHANGELOG.md files - "MD045": false, // XXX no-alt-text - // "MD004": { "style": "dash" } // ul-style + "MD012": false, // no-multiple-blanks, common in CHANGELOG.md files, ~1700 hits in changelog files + // "MD004": { "style": "dash" } // ul-style, ~3800 hits in 63 changelog files, XXX discuss just using "consistent" new default for dash }, "gitignore": true, "noBanner": true, diff --git a/README.md b/README.md index 0a952b33a9..7dede8487a 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@
- + test-all-versions badge Beta

@@ -74,7 +74,7 @@ We'd love your help! Use tags [up-for-grabs][up-for-grabs-issues] and [good firs ### Thanks to all the people who already contributed - + contributors ## Useful links diff --git a/examples/connect/README.md b/examples/connect/README.md index b8fc64cda2..bc6f2b6f7d 100644 --- a/examples/connect/README.md +++ b/examples/connect/README.md @@ -47,7 +47,7 @@ npm install Go to Zipkin with your browser -

+

Zipkin UI with trace

## Useful links diff --git a/examples/dns/README.md b/examples/dns/README.md index 21fc20348a..44f422cb8b 100644 --- a/examples/dns/README.md +++ b/examples/dns/README.md @@ -36,7 +36,7 @@ npm run zipkin:client `zipkin:client` script should output the `traceid` in the terminal (e.g `traceid: 4815c3d576d930189725f1f1d1bdfcc6`). Go to Zipkin with your browser (e.g ) -

+

Zipkin UI with trace

### Jaeger @@ -52,7 +52,7 @@ Go to Zipkin with your browser (e.g ) -

+

Jaeger UI with trace

## Useful links diff --git a/examples/express/README.md b/examples/express/README.md index 868d4332d3..5794a5077e 100644 --- a/examples/express/README.md +++ b/examples/express/README.md @@ -41,7 +41,7 @@ After a short time, the generated traces should be available in the Zipkin UI. Visit and click the "RUN QUERY" button to view recent traces, then click "SHOW" on a given trace. -

+

Zipkin UI with trace

### Jaeger @@ -59,7 +59,7 @@ npm run jaeger:client Visit the Jaeger UI at , select a service (e.g. "example-express-client"), click "Find Traces", then click on a trace to view it. -

+

Jaeger UI with trace

## Useful links diff --git a/examples/fastify/README.md b/examples/fastify/README.md index 378a46cf13..1ebe0395fd 100644 --- a/examples/fastify/README.md +++ b/examples/fastify/README.md @@ -53,7 +53,7 @@ npm install Go to Zipkin with your browser -

+

Zipkin UI with trace

## Useful links diff --git a/examples/hapi/README.md b/examples/hapi/README.md index 4835efa813..9dc64e6ece 100644 --- a/examples/hapi/README.md +++ b/examples/hapi/README.md @@ -44,7 +44,7 @@ Setup [Jaeger Tracing](https://www.jaegertracing.io/docs/latest/getting-started/ `zipkin:server` script should output the `traceid` in the terminal (e.g `traceid: 4815c3d576d930189725f1f1d1bdfcc6`). Go to Zipkin with your browser (e.g ) -

+

Zipkin UI with trace

### Jaeger @@ -67,7 +67,7 @@ Go to Zipkin with your browser (e.g ) -

+

Jaeger UI with trace

## Useful links diff --git a/examples/koa/README.md b/examples/koa/README.md index 3113a66200..08fa8196ef 100644 --- a/examples/koa/README.md +++ b/examples/koa/README.md @@ -44,7 +44,7 @@ Setup [Jaeger Tracing](https://www.jaegertracing.io/docs/latest/getting-started/ The `zipkin:server` script should output the `traceid` in the terminal (e.g `traceid: 4815c3d576d930189725f1f1d1bdfcc6`). Go to Zipkin with your browser (e.g ) -

+

Zipkin UI with trace

### Jaeger @@ -67,7 +67,7 @@ Go to Zipkin with your browser (e.g ) -

+

Jaeger UI with trace

## Useful links diff --git a/examples/mongodb/README.md b/examples/mongodb/README.md index 5cf2ea0368..756cebd331 100644 --- a/examples/mongodb/README.md +++ b/examples/mongodb/README.md @@ -50,7 +50,7 @@ After a short time, the generated traces should be available in the Zipkin UI. Visit and click the "RUN QUERY" button to view recent traces, then click "SHOW" on a given trace. -

+

Zipkin UI with trace

### Jaeger @@ -79,7 +79,7 @@ recent traces, then click "SHOW" on a given trace. Visit the Jaeger UI at , select a service (e.g. "example-express-client"), click "Find Traces", then click on a trace to view it. -

+

Jaeger UI with trace

## Useful links diff --git a/examples/mysql/README.md b/examples/mysql/README.md index 6540d8af74..4dd0437442 100644 --- a/examples/mysql/README.md +++ b/examples/mysql/README.md @@ -52,7 +52,7 @@ In case you want to see also metrics: The `zipkin:server` script should output the `traceid` in the terminal (e.g `traceid: 4815c3d576d930189725f1f1d1bdfcc6`). Go to Zipkin with your browser (e.g ) -

+

Zipkin UI with trace

### Jaeger @@ -75,7 +75,7 @@ Go to Zipkin with your browser (e.g ) -

+

Jaeger UI with trace

## Useful links diff --git a/examples/react-load/preact/README.md b/examples/react-load/preact/README.md index 79a71b36f8..bfa3e052d0 100644 --- a/examples/react-load/preact/README.md +++ b/examples/react-load/preact/README.md @@ -40,25 +40,25 @@ Take note of the parent-child relationships. #### First load Upon loading, mounting spans will be exported -

-

+

span data showing parentId

+

Zipkin UI showing trace

#### Pressing 'Enter' Here we can see the previous component unmounting and the new component mounting. -

-

-

+

span data showing parentId

+

Zipkin UI showing trace

+

Zipkin UI showing trace

#### Pressing 'Make Request' While in loading state: -

-

+

span data showing parentId

+

Zipkin UI showing trace

After a few seconds (when the request is fulfilled): -

-

+

span data showing parentId

+

Zipkin UI showing trace

## Useful links diff --git a/examples/react-load/react/README.md b/examples/react-load/react/README.md index ef4240bde0..5595d6ef35 100644 --- a/examples/react-load/react/README.md +++ b/examples/react-load/react/README.md @@ -40,28 +40,28 @@ Take note of the parent-child relationships. ### First load Upon loading, mounting spans will be exported -

-

+

span data showing parentId

+

Zipkin UI showing trace

### Pressing 'Enter' Here we can see the previous component unmounting and the new component mounting. -

-

-

+

span data showing parentId

+

Zipkin UI showing trace

+

Zipkin UI showing trace

### Pressing 'Make Request' While in loading state: -

-

+

span data showing parentId

+

Zipkin UI showing trace

After a few seconds (when the request is fulfilled): -

-

+

span data showing parentId

+

Zipkin UI showing trace

Since the example adds in a delay to the request, we can see that reflected in the duration of some spans: -

+

span data showing duration value

## Useful links diff --git a/examples/redis/README.md b/examples/redis/README.md index 6feb141f5f..0773ffad8f 100644 --- a/examples/redis/README.md +++ b/examples/redis/README.md @@ -61,7 +61,7 @@ After a short time, the generated traces should be available in the Zipkin UI. Visit and click the "RUN QUERY" button to view recent traces, then click "SHOW" on a given trace. -

+

Zipkin UI with trace

### Jaeger @@ -97,7 +97,7 @@ recent traces, then click "SHOW" on a given trace. Visit the Jaeger UI at , select a service (e.g. "example-express-client"), click "Find Traces", then click on a trace to view it. -

+

Jaeger UI with trace

## Useful links From 53a3adcb5112202ea607ff20afb511b320039692 Mon Sep 17 00:00:00 2001 From: Trent Mick Date: Wed, 22 May 2024 17:44:28 -0700 Subject: [PATCH 7/8] some rules to discuss --- .markdownlint-cli2.jsonc | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.markdownlint-cli2.jsonc b/.markdownlint-cli2.jsonc index 705ed18e1b..774c99a859 100644 --- a/.markdownlint-cli2.jsonc +++ b/.markdownlint-cli2.jsonc @@ -6,7 +6,8 @@ "MD024": false, "MD033": false, "MD041": false, - "MD012": false, // no-multiple-blanks, common in CHANGELOG.md files, ~1700 hits in changelog files + // XXX Rules to discuss: + "MD012": false // no-multiple-blanks, common in CHANGELOG.md files, ~1700 hits in changelog files // "MD004": { "style": "dash" } // ul-style, ~3800 hits in 63 changelog files, XXX discuss just using "consistent" new default for dash }, "gitignore": true, From 2e03f596834f87716718170361def9221f0a5898 Mon Sep 17 00:00:00 2001 From: Trent Mick Date: Thu, 23 May 2024 07:32:36 -0700 Subject: [PATCH 8/8] opt to avoid "" directives in every CHANGELOG.md file and choose options that work for all .md files --- .markdownlint-cli2.jsonc | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/.markdownlint-cli2.jsonc b/.markdownlint-cli2.jsonc index 774c99a859..89ebe7bf0e 100644 --- a/.markdownlint-cli2.jsonc +++ b/.markdownlint-cli2.jsonc @@ -6,9 +6,10 @@ "MD024": false, "MD033": false, "MD041": false, - // XXX Rules to discuss: - "MD012": false // no-multiple-blanks, common in CHANGELOG.md files, ~1700 hits in changelog files - // "MD004": { "style": "dash" } // ul-style, ~3800 hits in 63 changelog files, XXX discuss just using "consistent" new default for dash + // MD004/ul-style. We prefer dash, but generated CHANGELOG.md files use + // asterisk. The default "consistent" is a good compromise. + "MD004": { "style": "consistent" }, + "MD012": false // no-multiple-blanks; disabled because common in CHANGELOG.md files }, "gitignore": true, "noBanner": true,