chore: add script to verify READMEs and apply few fixes

.github/workflows/lint.yml

@@ -26,3 +26,6 @@ jobs:
       - run: npm ci
       - name: Lint
         run: npm run lint
+
+      - name: Verify READMEs
+        run: npm run readme:verify

detectors/node/opentelemetry-resource-detector-alibaba-cloud/README.md

@@ -46,3 +46,19 @@ Populates `cloud` and `host` for processes running on [Alibaba Cloud ECS](https:
 | host.type               | Value of `instance-type` on Alibaba Cloud                       |
 
 [resource-semantic_conventions]: https://github.com/open-telemetry/opentelemetry-specification/tree/master/specification/resource/semantic_conventions
+
+## Useful links
+
+- For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
+- For more about OpenTelemetry JavaScript: <https://github.com/open-telemetry/opentelemetry-js>
+- 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-alibaba-cloud
+[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fresource-detector-alibaba-cloud.svg

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: <https://opentelemetry.io/>
 - For more about OpenTelemetry JavaScript: <https://github.com/open-telemetry/opentelemetry-js>
 - 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

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

detectors/node/opentelemetry-resource-detector-gcp/README.md

@@ -56,10 +56,10 @@ This package uses `@opentelemetry/semantic-conventions` version `1.22+`, which i
 
 Apache 2.0 - See [LICENSE][license-url] for more information.
 
-[`gcp-metadata`]: https://www.npmjs.com/package/gcp-metadata
-[GCP Metadata Documentation]: https://cloud.google.com/compute/docs/metadata/overview
 [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-gcp
 [npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fresource-detector-gcp.svg
+[`gcp-metadata`]: https://www.npmjs.com/package/gcp-metadata
+[GCP Metadata Documentation]: https://cloud.google.com/compute/docs/metadata/overview

package.json

@@ -15,6 +15,7 @@
     "clean": "lerna run clean",
     "precompile": "tsc --version && npm run version:update",
     "version:update": "lerna run version:update",
+    "readme:verify": "lerna run readme:verify",
     "compile": "lerna run compile",
     "prewatch": "npm run precompile",
     "test": "lerna run test",

plugins/node/instrumentation-amqplib/package.json

@@ -37,6 +37,7 @@
     "test": "nyc ts-mocha -p tsconfig.json --require '@opentelemetry/contrib-test-utils' 'test/**/*.test.ts'",
     "test-all-versions": "tav",
     "version:update": "node ../../../scripts/version-update.js",
+    "readme:verify": "node ../../../scripts/verify-readme.js",
     "watch": "tsc -w",
     "test:docker:run": "docker run -d --hostname demo-amqplib-rabbit --name amqplib-unittests -p 22221:5672 --env RABBITMQ_DEFAULT_USER=username --env RABBITMQ_DEFAULT_PASS=password rabbitmq:3"
   },

plugins/node/instrumentation-cucumber/package.json

@@ -16,6 +16,7 @@
     "prewatch": "npm run precompile",
     "prepublishOnly": "npm run compile",
     "version:update": "node ../../../scripts/version-update.js",
+    "readme:verify": "node ../../../scripts/verify-readme.js",
     "compile": "tsc -p ."
   },
   "keywords": [

plugins/node/instrumentation-fs/package.json

@@ -15,6 +15,7 @@
     "prewatch": "npm run precompile",
     "prepublishOnly": "npm run compile",
     "version:update": "node ../../../scripts/version-update.js",
+    "readme:verify": "node ../../../scripts/verify-readme.js",
     "compile": "tsc -p ."
   },
   "keywords": [

plugins/node/instrumentation-kafkajs/package.json

@@ -15,6 +15,7 @@
     "prewatch": "npm run precompile",
     "prepublishOnly": "npm run compile",
     "version:update": "node ../../../scripts/version-update.js",
+    "readme:verify": "node ../../../scripts/verify-readme.js",
     "compile": "tsc -p ."
   },
   "keywords": [

plugins/node/instrumentation-lru-memoizer/package.json

@@ -16,6 +16,7 @@
     "prewatch": "npm run precompile",
     "prepublishOnly": "npm run compile",
     "version:update": "node ../../../scripts/version-update.js",
+    "readme:verify": "node ../../../scripts/verify-readme.js",
     "compile": "tsc -p ."
   },
   "keywords": [

plugins/node/instrumentation-mongoose/package.json

@@ -17,6 +17,7 @@
     "prewatch": "npm run precompile",
     "prepublishOnly": "npm run compile",
     "version:update": "node ../../../scripts/version-update.js",
+    "readme:verify": "node ../../../scripts/verify-readme.js",
     "compile": "tsc -p ."
   },
   "keywords": [

plugins/node/instrumentation-socket.io/package.json

@@ -16,6 +16,7 @@
     "prewatch": "npm run precompile",
     "prepublishOnly": "npm run compile",
     "version:update": "node ../../../scripts/version-update.js",
+    "readme:verify": "node ../../../scripts/verify-readme.js",
     "compile": "tsc -p ."
   },
   "keywords": [

plugins/node/opentelemetry-instrumentation-aws-lambda/README.md

@@ -9,10 +9,10 @@ This module provides automatic instrumentation for the [`AWS Lambda`](https://do
 
 If total installation size is not constrained, it is recommended to use the [`@opentelemetry/auto-instrumentations-node`](https://www.npmjs.com/package/@opentelemetry/auto-instrumentations-node) bundle with [@opentelemetry/sdk-node](`https://www.npmjs.com/package/@opentelemetry/sdk-node`) for the most seamless instrumentation experience.
 
-This module is currently under active development and not ready for general use.
-
 Compatible with OpenTelemetry JS API and SDK `1.0+`.
 
+This module is currently under active development and not ready for general use.
+
 ## Installation
 
 ```bash

plugins/node/opentelemetry-instrumentation-aws-lambda/package.json

@@ -15,6 +15,7 @@
     "prewatch": "npm run precompile",
     "prepublishOnly": "npm run compile",
     "version:update": "node ../../../scripts/version-update.js",
+    "readme:verify": "node ../../../scripts/verify-readme.js",
     "compile": "tsc -p ."
   },
   "keywords": [

plugins/node/opentelemetry-instrumentation-aws-sdk/README.md

@@ -9,6 +9,8 @@ This module provides automatic instrumentation for the [`aws-sdk` v2](https://do
 
 If total installation size is not constrained, it is recommended to use the [`@opentelemetry/auto-instrumentations-node`](https://www.npmjs.com/package/@opentelemetry/auto-instrumentations-node) bundle with [@opentelemetry/sdk-node](`https://www.npmjs.com/package/@opentelemetry/sdk-node`) for the most seamless instrumentation experience.
 
+Compatible with OpenTelemetry JS API and SDK `1.0+`.
+
 ## Installation
 
 ```bash

plugins/node/opentelemetry-instrumentation-aws-sdk/package.json

@@ -38,6 +38,7 @@
     "test": "nyc ts-mocha -p tsconfig.json --require '@opentelemetry/contrib-test-utils' 'test/**/*.test.ts'",
     "test-all-versions": "tav",
     "version:update": "node ../../../scripts/version-update.js",
+    "readme:verify": "node ../../../scripts/verify-readme.js",
     "watch": "tsc -w"
   },
   "peerDependencies": {

plugins/node/opentelemetry-instrumentation-cassandra/package.json

@@ -15,6 +15,7 @@
     "prewatch": "npm run precompile",
     "prepublishOnly": "npm run compile",
     "version:update": "node ../../../scripts/version-update.js",
+    "readme:verify": "node ../../../scripts/verify-readme.js",
     "compile": "tsc -p ."
   },
   "keywords": [

plugins/node/opentelemetry-instrumentation-connect/README.md

@@ -7,6 +7,8 @@ This module provides automatic instrumentation for the [`connect`](https://githu
 
 If total installation size is not constrained, it is recommended to use the [`@opentelemetry/auto-instrumentations-node`](https://www.npmjs.com/package/@opentelemetry/auto-instrumentations-node) bundle with [@opentelemetry/sdk-node](`https://www.npmjs.com/package/@opentelemetry/sdk-node`) for the most seamless instrumentation experience.
 
+Compatible with OpenTelemetry JS API and SDK `1.0+`.
+
 ## Status
 
 | Maturity                                              | [Component Owner](../../../.github/component_owners.yml) | Compatibility         |

plugins/node/opentelemetry-instrumentation-connect/package.json

@@ -15,6 +15,7 @@
     "prepublishOnly": "npm run compile",
     "test": "nyc ts-mocha -p tsconfig.json 'test/**/*.test.ts'",
     "version:update": "node ../../../scripts/version-update.js",
+    "readme:verify": "node ../../../scripts/verify-readme.js",
     "watch": "tsc -w"
   },
   "keywords": [

plugins/node/opentelemetry-instrumentation-dns/README.md

@@ -7,6 +7,8 @@ This module provides automatic instrumentation for the [`dns`](http://nodejs.org
 
 If total installation size is not constrained, it is recommended to use the [`@opentelemetry/auto-instrumentations-node`](https://www.npmjs.com/package/@opentelemetry/auto-instrumentations-node) bundle with [@opentelemetry/sdk-node](`https://www.npmjs.com/package/@opentelemetry/sdk-node`) for the most seamless instrumentation experience.
 
+Compatible with OpenTelemetry JS API and SDK `1.0+`.
+
 ## Status
 
 | Maturity                                              | [Component Owner](../../../.github/component_owners.yml) | Compatibility         |

plugins/node/opentelemetry-instrumentation-dns/package.json

@@ -15,6 +15,7 @@
     "prewatch": "npm run precompile",
     "prepublishOnly": "npm run compile",
     "version:update": "node ../../../scripts/version-update.js",
+    "readme:verify": "node ../../../scripts/verify-readme.js",
     "compile": "tsc -p ."
   },
   "keywords": [

plugins/node/opentelemetry-instrumentation-express/package.json

@@ -15,6 +15,7 @@
     "precompile": "tsc --version && lerna run version:update --scope @opentelemetry/instrumentation-express --include-dependencies",
     "prewatch": "npm run precompile",
     "version:update": "node ../../../scripts/version-update.js",
+    "readme:verify": "node ../../../scripts/verify-readme.js",
     "compile": "tsc -p .",
     "prepublishOnly": "npm run compile",
     "watch": "tsc -w"

plugins/node/opentelemetry-instrumentation-fastify/README.md

@@ -7,6 +7,8 @@ This module provides automatic instrumentation for the [`fastify`](https://www.f
 
 If total installation size is not constrained, it is recommended to use the [`@opentelemetry/auto-instrumentations-node`](https://www.npmjs.com/package/@opentelemetry/auto-instrumentations-node) bundle with [@opentelemetry/sdk-node](`https://www.npmjs.com/package/@opentelemetry/sdk-node`) for the most seamless instrumentation experience.
 
+Compatible with OpenTelemetry JS API and SDK `1.0+`.
+
 ## Installation
 
 This instrumentation relies on HTTP calls to also be instrumented. Make sure you install and enable both, otherwise you will have spans that are not connected with each other.

plugins/node/opentelemetry-instrumentation-fastify/package.json

@@ -15,6 +15,7 @@
     "test": "nyc ts-mocha -p tsconfig.json 'test/**/*.test.ts'",
     "test-all-versions": "tav",
     "version:update": "node ../../../scripts/version-update.js",
+    "readme:verify": "node ../../../scripts/verify-readme.js",
     "prewatch": "npm run precompile",
     "watch": "tsc -w"
   },

plugins/node/opentelemetry-instrumentation-generic-pool/package.json

@@ -14,6 +14,7 @@
     "precompile": "tsc --version && lerna run version:update --scope @opentelemetry/instrumentation-generic-pool --include-dependencies",
     "prewatch": "npm run precompile",
     "version:update": "node ../../../scripts/version-update.js",
+    "readme:verify": "node ../../../scripts/verify-readme.js",
     "compile": "tsc -p .",
     "prepublishOnly": "npm run compile",
     "watch": "tsc -w"

plugins/node/opentelemetry-instrumentation-graphql/README.md

@@ -9,10 +9,10 @@ This module provides automatic instrumentation and tracing for GraphQL in Node.j
 
 If total installation size is not constrained, it is recommended to use the [`@opentelemetry/auto-instrumentations-node`](https://www.npmjs.com/package/@opentelemetry/auto-instrumentations-node) bundle with [@opentelemetry/sdk-node](`https://www.npmjs.com/package/@opentelemetry/sdk-node`) for the most seamless instrumentation experience.
 
-*Note*: graphql plugin instruments graphql directly. it should work with any package that wraps the graphql package (e.g apollo).
-
 Compatible with OpenTelemetry JS API and SDK `1.0+`.
 
+*Note*: graphql plugin instruments graphql directly. it should work with any package that wraps the graphql package (e.g apollo).
+
 ## Installation
 
 ```shell script
@@ -131,7 +131,7 @@ This package does not currently generate any attributes from semantic convention
 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/blob/main/LICENSE
+[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/instrumentation-graphql
 [npm-img]: https://badge.fury.io/js/%40opentelemetry%2Finstrumentation-graphql.svg

plugins/node/opentelemetry-instrumentation-graphql/package.json

@@ -17,6 +17,7 @@
     "test-all-versions": "tav",
     "tdd": "npm run test -- --watch-extensions ts --watch",
     "version:update": "node ../../../scripts/version-update.js",
+    "readme:verify": "node ../../../scripts/verify-readme.js",
     "watch": "tsc -w"
   },
   "keywords": [

plugins/node/opentelemetry-instrumentation-hapi/README.md

@@ -7,6 +7,8 @@ This module provides automatic instrumentation for the [Hapi Framework](https://
 
 If total installation size is not constrained, it is recommended to use the [`@opentelemetry/auto-instrumentations-node`](https://www.npmjs.com/package/@opentelemetry/auto-instrumentations-node) bundle with [@opentelemetry/sdk-node](`https://www.npmjs.com/package/@opentelemetry/sdk-node`) for the most seamless instrumentation experience.
 
+Compatible with OpenTelemetry JS API and SDK `1.0+`.
+
 ## Status
 
 | Maturity                                              | [Component Owner](../../../.github/component_owners.yml) | Compatibility         |

plugins/node/opentelemetry-instrumentation-hapi/package.json

@@ -15,6 +15,7 @@
     "precompile": "tsc --version && lerna run version:update --scope @opentelemetry/instrumentation-hapi --include-dependencies",
     "prewatch": "npm run precompile",
     "version:update": "node ../../../scripts/version-update.js",
+    "readme:verify": "node ../../../scripts/verify-readme.js",
     "compile": "tsc -p .",
     "prepublishOnly": "npm run compile"
   },

plugins/node/opentelemetry-instrumentation-ioredis/package.json

@@ -18,6 +18,7 @@
     "precompile": "tsc --version && lerna run version:update --scope @opentelemetry/instrumentation-ioredis --include-dependencies",
     "prewatch": "npm run precompile",
     "version:update": "node ../../../scripts/version-update.js",
+    "readme:verify": "node ../../../scripts/verify-readme.js",
     "compile": "tsc -p .",
     "prepublishOnly": "npm run compile"
   },

plugins/node/opentelemetry-instrumentation-knex/package.json

@@ -14,6 +14,7 @@
     "precompile": "tsc --version && lerna run version:update --scope @opentelemetry/instrumentation-knex --include-dependencies",
     "prewatch": "npm run precompile",
     "version:update": "node ../../../scripts/version-update.js",
+    "readme:verify": "node ../../../scripts/verify-readme.js",
     "compile": "tsc -p .",
     "prepublishOnly": "npm run compile",
     "watch": "tsc -w"

plugins/node/opentelemetry-instrumentation-koa/README.md

@@ -7,6 +7,8 @@ This module provides automatic instrumentation for the [Koa](https://github.com/
 
 If total installation size is not constrained, it is recommended to use the [`@opentelemetry/auto-instrumentations-node`](https://www.npmjs.com/package/@opentelemetry/auto-instrumentations-node) bundle with [@opentelemetry/sdk-node](`https://www.npmjs.com/package/@opentelemetry/sdk-node`) for the most seamless instrumentation experience.
 
+Compatible with OpenTelemetry JS API and SDK `1.0+`.
+
 ## Status
 
 | Maturity                                              | [Component Owner](../../../.github/component_owners.yml) | Compatibility         |

plugins/node/opentelemetry-instrumentation-koa/package.json

@@ -15,6 +15,7 @@
     "precompile": "tsc --version && lerna run version:update --scope @opentelemetry/instrumentation-koa --include-dependencies",
     "prewatch": "npm run precompile",
     "version:update": "node ../../../scripts/version-update.js",
+    "readme:verify": "node ../../../scripts/verify-readme.js",
     "compile": "tsc -p .",
     "prepublishOnly": "npm run compile",
     "watch": "tsc -w"

plugins/node/opentelemetry-instrumentation-mongodb/package.json

@@ -19,6 +19,7 @@
     "precompile": "tsc --version && lerna run version:update --scope @opentelemetry/instrumentation-mongodb --include-dependencies",
     "prewatch": "npm run precompile",
     "version:update": "node ../../../scripts/version-update.js",
+    "readme:verify": "node ../../../scripts/verify-readme.js",
     "compile": "tsc -p .",
     "prepublishOnly": "npm run compile",
     "watch": "tsc -w"

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/

plugins/node/opentelemetry-instrumentation-net/README.md

@@ -7,10 +7,10 @@ This module provides automatic instrumentation for the [`net`](http://nodejs.org
 
 If total installation size is not constrained, it is recommended to use the [`@opentelemetry/auto-instrumentations-node`](https://www.npmjs.com/package/@opentelemetry/auto-instrumentations-node) bundle with [@opentelemetry/sdk-node](`https://www.npmjs.com/package/@opentelemetry/sdk-node`) for the most seamless instrumentation experience.
 
-Supports both TCP and IPC connections.
-
 Compatible with OpenTelemetry JS API and SDK `1.0+`.
 
+Supports both TCP and IPC connections.
+
 ## Installation
 
 ```bash

plugins/node/opentelemetry-instrumentation-net/package.json

@@ -15,6 +15,7 @@
     "prewatch": "npm run precompile",
     "prepublishOnly": "npm run compile",
     "version:update": "node ../../../scripts/version-update.js",
+    "readme:verify": "node ../../../scripts/verify-readme.js",
     "compile": "tsc -p ."
   },
   "keywords": [

plugins/node/opentelemetry-instrumentation-pg/package.json

@@ -20,6 +20,7 @@
     "test:debug": "ts-mocha --inspect-brk --no-timeouts -p tsconfig.json 'test/**/*.test.ts'",
     "test:local": "cross-env RUN_POSTGRES_TESTS_LOCAL=true npm run test",
     "version:update": "node ../../../scripts/version-update.js",
+    "readme:verify": "node ../../../scripts/verify-readme.js",
     "watch": "tsc -w"
   },
   "keywords": [

plugins/node/opentelemetry-instrumentation-pino/package.json

@@ -16,6 +16,7 @@
     "prewatch": "npm run precompile",
     "prepublishOnly": "npm run compile",
     "version:update": "node ../../../scripts/version-update.js",
+    "readme:verify": "node ../../../scripts/verify-readme.js",
     "compile": "tsc -p ."
   },
   "keywords": [

plugins/node/opentelemetry-instrumentation-redis-4/package.json

@@ -20,6 +20,7 @@
     "precompile": "tsc --version && lerna run version:update --scope @opentelemetry/instrumentation-redis-4 --include-dependencies",
     "prewatch": "npm run precompile",
     "version:update": "node ../../../scripts/version-update.js",
+    "readme:verify": "node ../../../scripts/verify-readme.js",
     "compile": "tsc -p .",
     "prepublishOnly": "npm run compile"
   },

plugins/node/opentelemetry-instrumentation-redis/package.json

@@ -20,6 +20,7 @@
     "precompile": "tsc --version && lerna run version:update --scope @opentelemetry/instrumentation-redis --include-dependencies",
     "prewatch": "npm run precompile",
     "version:update": "node ../../../scripts/version-update.js",
+    "readme:verify": "node ../../../scripts/verify-readme.js",
     "compile": "tsc -p .",
     "prepublishOnly": "npm run compile"
   },

plugins/node/opentelemetry-instrumentation-restify/package.json

@@ -17,6 +17,7 @@
     "test": "nyc ts-mocha -p tsconfig.json 'test/**/*.ts'",
     "test-all-versions": "tav",
     "version:update": "node ../../../scripts/version-update.js",
+    "readme:verify": "node ../../../scripts/verify-readme.js",
     "watch": "tsc -w"
   },
   "keywords": [