ci: add md linter rule to only use dash for unordered lists (#2205)

blumamir · web-flow · commit 0948b9f65329 · 2024-05-16T08:57:12.000+03:00
* ci: add md linter rule to only use dash for unordered lists

* style: use unordered list as dash in READMEs

* chore: comment on markdown lint rule

* fix: unintentional replace
diff --git a/.github/markdown-lint.yml b/.github/markdown-lint.yml
@@ -0,0 +1,5 @@
+# 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
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -19,6 +19,7 @@ jobs:
       - name: Lint markdown files
         uses: avto-dev/markdown-lint@v1
         with:
+          config: '.github/markdown-lint.yml'
           ignore: "./**/CHANGELOG.md"
           args: "./**/*.md"
 
diff --git a/README.md b/README.md
@@ -42,10 +42,10 @@ A repository for OpenTelemetry JavaScript contributions that are not part of the
 
 This project includes:
 
-* [Instrumentations & other plugins](./plugins),
-* [Metapackages](./metapackages),
-* [Context Propagators](./propagators),
-* [Resource Detectors](./detectors).
+- [Instrumentations & other plugins](./plugins),
+- [Metapackages](./metapackages),
+- [Context Propagators](./propagators),
+- [Resource Detectors](./detectors).
 
 **Instrumentations**: OpenTelemetry can collect tracing data automatically using instrumentations. Vendors/Users can also create and use their own.
 
@@ -59,9 +59,9 @@ Stability level for components in this repository follow the definitions in [CON
 
 Packages in this repository have a variable range of support for Node.JS and browser versions which for each package depend on
 
-* the activeness of the owners of those packages,
-* used techniques or runtime features and
-* in the case of the auto-instrumentations, the supported runtime versions for the underlying package.
+- the activeness of the owners of those packages,
+- used techniques or runtime features and
+- in the case of the auto-instrumentations, the supported runtime versions for the underlying package.
 
 See the `README.md` files and the `engines` field in the `package.json` files for the respective packages for support information about that package.
 
@@ -79,9 +79,9 @@ We'd love your help! Use tags [up-for-grabs][up-for-grabs-issues] and [good firs
 
 ## Useful links
 
-* For more information on OpenTelemetry, visit [OpenTelemetry.io](https://opentelemetry.io/)
-* For help or feedback on this project, join us in [GitHub Discussions][discussions-url] or in [Slack](https://cloud-native.slack.com/archives/C01NL1GRPQR)
-* For more 3rd party components for JS as well as other languages, check [OpenTelemetry Registry](https://opentelemetry.io/registry/)
+- For more information on OpenTelemetry, visit [OpenTelemetry.io](https://opentelemetry.io/)
+- For help or feedback on this project, join us in [GitHub Discussions][discussions-url] or in [Slack](https://cloud-native.slack.com/archives/C01NL1GRPQR)
+- For more 3rd party components for JS as well as other languages, check [OpenTelemetry Registry](https://opentelemetry.io/registry/)
 
 ## License
 
diff --git a/RELEASING.md b/RELEASING.md
@@ -9,15 +9,15 @@ For posterity, or in the event of any failures with release-please, the process
 
 Manual Release Process Steps:
 
-* [Update to latest locally](#update-to-latest-locally)
-* [Create a new branch](#create-a-new-branch)
-* [Prepare each package for release](#prepare-each-package-for-release)
-* [Use the Changelog to create a GitHub Release](#use-the-changelog-to-create-a-github-release)
-* [Create a new PR](#create-a-new-pr)
-* [Merge and pull](#merge-and-pull)
-* [Publish all packages](#publish-all-packages)
-* [Publish the GitHub Release](#publish-the-github-release)
-* [Update CHANGELOG](#update-changelog)
+- [Update to latest locally](#update-to-latest-locally)
+- [Create a new branch](#create-a-new-branch)
+- [Prepare each package for release](#prepare-each-package-for-release)
+- [Use the Changelog to create a GitHub Release](#use-the-changelog-to-create-a-github-release)
+- [Create a new PR](#create-a-new-pr)
+- [Merge and pull](#merge-and-pull)
+- [Publish all packages](#publish-all-packages)
+- [Publish the GitHub Release](#publish-the-github-release)
+- [Update CHANGELOG](#update-changelog)
 
 ## Update to latest locally
 
@@ -31,9 +31,9 @@ Create a new branch called `x.y.z-proposal` from the current commit.
 
 Decide on the next `major.minor.patch` release number based on [semver](http://semver.org/) guidelines.
 
-* Use `npm install` command to initialize all package directories
-* Use `lerna publish --skip-npm --no-git-tag-version --no-push` to bump the version in all `package.json`
-* Use `npm run bootstrap` to generate latest `version.ts` files
+- Use `npm install` command to initialize all package directories
+- Use `lerna publish --skip-npm --no-git-tag-version --no-push` to bump the version in all `package.json`
+- Use `npm run bootstrap` to generate latest `version.ts` files
 
 ## Use the Changelog to create a GitHub Release
 
@@ -58,10 +58,10 @@ It will print something like:
 ## Unreleased (2018-05-24)
 
 #### :bug: Bug Fix
-* [#198](https://github.com/my-org/my-repo/pull/198) Avoid an infinite loop ([@helpful-hacker](https://github.com/helpful-hacker))
+- [#198](https://github.com/my-org/my-repo/pull/198) Avoid an infinite loop ([@helpful-hacker](https://github.com/helpful-hacker))
 
 #### :house: Internal
-* [#183](https://github.com/my-org/my-repo/pull/183) Standardize error messages ([@careful-coder](https://github.com/careful-coder))
+- [#183](https://github.com/my-org/my-repo/pull/183) Standardize error messages ([@careful-coder](https://github.com/careful-coder))
 
 #### Commiters: 2
 - Helpful Hacker ([@helpful-hacker](https://github.com/helpful-hacker))
@@ -112,10 +112,10 @@ Publish the GitHub release, ensuring that the tag points to the newly landed com
 
 ## Update CHANGELOG
 
-* After releasing is done, update the [CHANGELOG.md](https://github.com/open-telemetry/opentelemetry-js/blob/main/CHANGELOG.md) and start new Unreleased label.
-* Create a new commit with the exact title: `Post Release: update CHANGELOG.md`.
-* Go through PR review and merge it to GitHub main branch.
+- After releasing is done, update the [CHANGELOG.md](https://github.com/open-telemetry/opentelemetry-js/blob/main/CHANGELOG.md) and start new Unreleased label.
+- Create a new commit with the exact title: `Post Release: update CHANGELOG.md`.
+- Go through PR review and merge it to GitHub main branch.
 
 ## Known Issues
 
-* The `examples/` and `getting-started/` folders are not part of lerna packages, we need to manually bump the version in `package.json`.
+- The `examples/` and `getting-started/` folders are not part of lerna packages, we need to manually bump the version in `package.json`.
diff --git a/archive/opentelemetry-browser-extension-autoinjection/README.md b/archive/opentelemetry-browser-extension-autoinjection/README.md
@@ -13,9 +13,9 @@ Compatible with OpenTelemetry JS API and SDK `1.0+`.
 
 ## Supported Environments
 
-* Google Chrome (with [Manifest Version 3](https://developer.chrome.com/docs/extensions/mv3/intro/) support)
-* Chromium (with Manifest Version 2)
-* Firefox (*unstable*, with Manifest Version 2)
+- Google Chrome (with [Manifest Version 3](https://developer.chrome.com/docs/extensions/mv3/intro/) support)
+- Chromium (with Manifest Version 2)
+- Firefox (*unstable*, with Manifest Version 2)
 
 ## Installation
 
@@ -32,9 +32,9 @@ npm run build
 
 This will create a so-called unpacked extension into the `build/` folder you now can load into your browser:
 
-* Open a new browser window and go to chrome://extensions
-* Turn on "Developer Mode"
-* Click on "Load unpacked" and select the `build/mv3` (or `build/mv2`) folder, which contains the extension
+- Open a new browser window and go to chrome://extensions
+- Turn on "Developer Mode"
+- Click on "Load unpacked" and select the `build/mv3` (or `build/mv2`) folder, which contains the extension
 
 If all goes well you should see the extension listed:
 
diff --git a/archive/opentelemetry-propagator-grpc-census-binary/README.md b/archive/opentelemetry-propagator-grpc-census-binary/README.md
@@ -5,8 +5,8 @@
 
 OpenTelemetry gRPC Census propagator provides gRPC header propagation for systems that use the OpenCensus 'grpc-trace-bin' binary header format. This allows for context propagation when either:
 
-* incoming gRPC calls come from services already instrumented using OpenCensus
-* outgoing gRPC calls go to services already instrumented using OpenCensus
+- incoming gRPC calls come from services already instrumented using OpenCensus
+- outgoing gRPC calls go to services already instrumented using OpenCensus
 
 This propagator works in conjunction with the OpenTelemetry [gRPC plugin](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/exporter-trace-otlp-grpc).
 
@@ -43,9 +43,9 @@ See [binary-format.ts](https://github.com/census-instrumentation/opencensus-node
 
 ## 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]
+- 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
 
diff --git a/packages/baggage-span-processor/README.md b/packages/baggage-span-processor/README.md
@@ -48,9 +48,9 @@ sdk.start();
 
 ## 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]
+- 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
 
diff --git a/packages/opentelemetry-host-metrics/README.md b/packages/opentelemetry-host-metrics/README.md
@@ -5,9 +5,9 @@
 
 This module provides automatic collection of Host Metrics which includes metrics for:
 
-* CPU
-* Memory
-* Network
+- CPU
+- Memory
+- Network
 
 Compatible with OpenTelemetry JS API and SDK `1.0+`.
 
@@ -41,9 +41,9 @@ hostMetrics.start();
 
 ## 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]
+- 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
 
diff --git a/packages/winston-transport/README.md b/packages/winston-transport/README.md
@@ -55,9 +55,9 @@ Winston `3.x`
 
 ## 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]
+- 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
 
diff --git a/plugins/node/opentelemetry-instrumentation-cassandra/README.md b/plugins/node/opentelemetry-instrumentation-cassandra/README.md
@@ -66,9 +66,9 @@ Attributes collected:
 
 ## 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]
+- 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
 
diff --git a/plugins/node/opentelemetry-instrumentation-net/README.md b/plugins/node/opentelemetry-instrumentation-net/README.md
@@ -52,9 +52,9 @@ Attributes added to `connect` spans:
 
 ## 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]
+- 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
 
diff --git a/plugins/node/opentelemetry-instrumentation-pino/README.md b/plugins/node/opentelemetry-instrumentation-pino/README.md
@@ -55,9 +55,9 @@ logger.info('foobar');
 
 For the current active span, the following fields are injected. These field names can be optionally configured via `logKeys` in the PinoInstrumentation config:
 
-* `trace_id`
-* `span_id`
-* `trace_flags`
+- `trace_id`
+- `span_id`
+- `trace_flags`
 
 When no span context is active or the span context is invalid, injection is skipped.
 
@@ -71,9 +71,9 @@ This package does not currently generate any attributes from semantic convention
 
 ## 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]
+- 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
 
diff --git a/plugins/node/opentelemetry-instrumentation-winston/README.md b/plugins/node/opentelemetry-instrumentation-winston/README.md
@@ -84,9 +84,9 @@ identifying the span added to the log record. This allows
 log records with tracing data. The added fields are
 ([spec](https://opentelemetry.io/docs/specs/otel/compatibility/logging_trace_context/)):
 
-* `trace_id`
-* `span_id`
-* `trace_flags`
+- `trace_id`
+- `span_id`
+- `trace_flags`
 
 After adding these fields, the optional `logHook` is called to allow injecting additional fields. For example:
 
@@ -112,9 +112,9 @@ This package does not currently generate any attributes from semantic convention
 
 ## 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]
+- 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
 
diff --git a/propagators/README.md b/propagators/README.md
@@ -22,8 +22,8 @@ api.propagation.setGlobalPropagator(new GrpcCensusPropagator());
 
 ## Useful links
 
-* For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
-* For more about OpenTelemetry JavaScript: <https://github.com/open-telemetry/opentelemetry-js>
+- For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
+- For more about OpenTelemetry JavaScript: <https://github.com/open-telemetry/opentelemetry-js>
 
 ## License
 
diff --git a/propagators/opentelemetry-propagator-instana/README.md b/propagators/opentelemetry-propagator-instana/README.md
@@ -40,36 +40,36 @@ There are three headers that the propagator handles: `X-INSTANA-T` (the trace ID
 
 Example header triplet:
 
-* `X-INSTANA-T: 80f198ee56343ba864fe8b2a57d3eff7`,
-* `X-INSTANA-S: e457b5a2e4d86bd1`,
-* `X-INSTANA-L: 1`.
+- `X-INSTANA-T: 80f198ee56343ba864fe8b2a57d3eff7`,
+- `X-INSTANA-S: e457b5a2e4d86bd1`,
+- `X-INSTANA-L: 1`.
 
 A short summary for each of the headers is provided below. More details are available at <https://www.ibm.com/docs/en/obi/current?topic=monitoring-traces#tracing-headers>.
 
 ### X-INSTANA-T -- trace ID
 
-* A string of either 16 or 32 characters from the alphabet `0-9a-f`, representing either a 64 bit or 128 bit ID.
-* This header corresponds to the [OpenTelemetry TraceId](https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/overview.md#spancontext).
-* If the propagator receives an X-INSTANA-T header value that is shorter than 32 characters when _extracting_ headers into the OpenTelemetry span context, it will left-pad the string with the character "0" to length 32.
-* No length transformation is applied when _injecting_ the span context into headers.
+- A string of either 16 or 32 characters from the alphabet `0-9a-f`, representing either a 64 bit or 128 bit ID.
+- This header corresponds to the [OpenTelemetry TraceId](https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/overview.md#spancontext).
+- If the propagator receives an X-INSTANA-T header value that is shorter than 32 characters when _extracting_ headers into the OpenTelemetry span context, it will left-pad the string with the character "0" to length 32.
+- No length transformation is applied when _injecting_ the span context into headers.
 
 ### X-INSTANA-S -- parent span ID
 
-* Format: A string of 16 characters from the alphabet `0-9a-f`, representing a 64 bit ID.
-* This header corresponds to the [OpenTelemetry SpanId](https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/overview.md#spancontext).
+- Format: A string of 16 characters from the alphabet `0-9a-f`, representing a 64 bit ID.
+- This header corresponds to the [OpenTelemetry SpanId](https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/overview.md#spancontext).
 
 ### X-INSTANA-L - sampling level
 
-* The only two valid values are `1` and `0`.
-* A level of `1` means that this request is to be sampled, a level of `0` means that the request should not be sampled.
-* This header corresponds to the sampling bit of the [OpenTelemetry TraceFlags](https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/overview.md#spancontext).
+- The only two valid values are `1` and `0`.
+- A level of `1` means that this request is to be sampled, a level of `0` means that the request should not be sampled.
+- This header corresponds to the sampling bit of the [OpenTelemetry TraceFlags](https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/overview.md#spancontext).
 
 ## Useful links
 
-* For more information on Instana, visit <https://www.instana.com/> and [Instana' documentation](https://www.ibm.com/docs/en/obi/current).
-* 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]
+- For more information on Instana, visit <https://www.instana.com/> and [Instana' documentation](https://www.ibm.com/docs/en/obi/current).
+- 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
 
