Skip to content

Commit 0078d0c

Browse files
trentmtrentm
authored
chore(lint): refactor Markdown linting to use markdownlint-cli2 (open-telemetry#2234)
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. - remove errant Dependencies sections from the top of some changelog files found by rule MD001 (see open-telemetry#2207) Refs: open-telemetry/opentelemetry-js#4713 Closes: open-telemetry#2207
1 parent 50ff98b commit 0078d0c

File tree

52 files changed

+425
-673
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

52 files changed

+425
-673
lines changed

‎.github/ISSUE_TEMPLATE/plugin_request.md

+2
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,11 @@ A clear and concise description of what the problem is. Ex. I'm always frustrate
2020

2121

2222
### Do you expect this instrumentation to be commonly used?
23+
2324
Weekly Downloads:
2425

2526
### What version of instrumentation are you interested in using?
27+
2628
Versions:
2729

2830
### Additional context

‎.github/markdown-lint.yml

-5
This file was deleted.

‎.github/workflows/lint.yml

+3-9
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,8 @@ jobs:
1515
with:
1616
node-version: 18
1717
cache: 'npm'
18-
19-
- name: Lint markdown files
20-
uses: avto-dev/markdown-lint@v1
21-
with:
22-
config: '.github/markdown-lint.yml'
23-
ignore: "./**/CHANGELOG.md"
24-
args: "./**/*.md"
25-
2618
- run: npm ci
2719
- name: Lint
28-
run: npm run lint
20+
run: |
21+
npm run lint
22+
npm run lint:markdown

‎.markdownlint-cli2.jsonc

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
// https://github.com/DavidAnson/markdownlint-cli2#markdownlint-cli2jsonc
2+
{
3+
"config": {
4+
// https://github.com/DavidAnson/markdownlint/blob/main/README.md#rules--aliases
5+
"MD013": false,
6+
"MD024": false,
7+
"MD033": false,
8+
"MD041": false,
9+
// MD004/ul-style. We prefer dash, but generated CHANGELOG.md files use
10+
// asterisk. The default "consistent" is a good compromise.
11+
"MD004": { "style": "consistent" },
12+
"MD012": false // no-multiple-blanks; disabled because common in CHANGELOG.md files
13+
},
14+
"gitignore": true,
15+
"noBanner": true,
16+
"noProgress": true
17+
}

‎.markdownlint.json

-7
This file was deleted.

‎CHANGELOG.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
<!-- markdownlint-disable -->
12
# CHANGELOG
23

34
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).

‎CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ With the exception of the stable status, it is up to each individual [component
150150
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.
151151

152152
A Pull Request modifying components in any stage of the lifecycle is subject to the
153-
[Pull Request Merge Requirements](#pull-request-merge-requirements).
153+
[Pull Request Merge Guidelines](#pull-request-merge-guidelines).
154154

155155
### Unreleased
156156

‎README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
</a>
1818
<br/>
1919
<a href="https://github.com/open-telemetry/opentelemetry-js-contrib/actions/workflows/test-all-versions.yml">
20-
<img src="https://github.com/open-telemetry/opentelemetry-js-contrib/actions/workflows/test-all-versions.yml/badge.svg">
20+
<img alt="test-all-versions badge" src="https://github.com/open-telemetry/opentelemetry-js-contrib/actions/workflows/test-all-versions.yml/badge.svg">
2121
</a>
2222
<img alt="Beta" src="https://img.shields.io/badge/status-beta-informational?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAYAAADgdz34AAAAAXNSR0IArs4c6QAAAIRlWElmTU0AKgAAAAgABQESAAMAAAABAAEAAAEaAAUAAAABAAAASgEbAAUAAAABAAAAUgEoAAMAAAABAAIAAIdpAAQAAAABAAAAWgAAAAAAAACQAAAAAQAAAJAAAAABAAOgAQADAAAAAQABAACgAgAEAAAAAQAAABigAwAEAAAAAQAAABgAAAAA8A2UOAAAAAlwSFlzAAAWJQAAFiUBSVIk8AAAAVlpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IlhNUCBDb3JlIDUuNC4wIj4KICAgPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4KICAgICAgPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIKICAgICAgICAgICAgeG1sbnM6dGlmZj0iaHR0cDovL25zLmFkb2JlLmNvbS90aWZmLzEuMC8iPgogICAgICAgICA8dGlmZjpPcmllbnRhdGlvbj4xPC90aWZmOk9yaWVudGF0aW9uPgogICAgICA8L3JkZjpEZXNjcmlwdGlvbj4KICAgPC9yZGY6UkRGPgo8L3g6eG1wbWV0YT4KTMInWQAABK5JREFUSA2dVm1sFEUYfmd2b/f2Pkqghn5eEQWKrRgjpkYgpoRCLC0oxV5apAiGUDEpJvwxEQ2raWPU+Kf8INU/RtEedwTCR9tYPloxGNJYTTQUwYqJ1aNpaLH3sXu3t7vjvFevpSqt7eSyM+/czvM8877PzB3APBoLgoDLsNePF56LBwqa07EKlDGg84CcWsI4CEbhNnDpAd951lXE2NkiNknCCTLv4HtzZuvPm1C/IKv4oDNXqNDHragety2XVzjECZsJARuBMyRzJrh1O0gQwLXuxofxsPSj4hG8fMLQo7bl9JJD8XZfC1E5yWFOMtd07dvX5kDwg6+2++Chq8txHGtfPoAp0gOFmhYoNFkHjn2TNUmrwRdna7W1QSkU8hvbGk4uThLrapaiLA2E6QY4u/lS9ItHfvJkxYsTMVtnAJLipYIWtVrcdX+8+b8IVnPl/R81prbuPZ1jpYw+0aEUGSkdFsgyBIaFTXCm6nyaxMtJ4n+TeDhJzGqZtQZcuYDgqDwDbqb0JF9oRpIG1Oea3bC1Y6N3x/WV8Zh83emhCs++hlaghDw+8w5UlYKq2lU7Pl8IkvS9KDqXmKmEwdMppVPKwGSEilmyAwJhRwWcq7wYC6z4wZ1rrEoMWxecdOjZWXeAQClBcYDN3NwVwD9pGwqUSyQgclcmxpNJqCuwLmDh3WtvPqXdlt+6Oz70HPGDNSNBee/EOen+rGbEFqDENBPDbtdCp0ukPANmzO0QQJYUpyS5IJJI3Hqt4maS+EB3199ozm8EDU/6fVNU2dQpdx3ZnKzeFXyaUTiasEV/gZMzJMjr3Z+WvAdQ+hs/zw9savimxUntDSaBdZ2f+Idbm1rlNY8esFffBit9HtK5/MejsrJVxikOXlb1Ukir2X+Rbdkd1KG2Ixfn2Ql4JRmELnYK9mEM8G36fAA3xEQ89fxXihC8q+sAKi9jhHxNqagY2hiaYgRCm0f0QP7H4Fp11LSXiuBY2aYFlh0DeDIVVFUJQn5rCnpiNI2gvLxHnASn9DIVHJJlm5rXvQAGEo4zvKq2w5G1NxENN7jrft1oxMdekETjxdH2Z3x+VTVYsPb+O0C/9/auN6v2hNZw5b2UOmSbG5/rkC3LBA+1PdxFxORjxpQ81GcxKc+ybVjEBvUJvaGJ7p7n5A5KSwe4AzkasA+crmzFtowoIVTiLjANm8GDsrWW35ScI3JY8Urv83tnkF8JR0yLvEt2hO/0qNyy3Jb3YKeHeHeLeOuVLRpNF+pkf85OW7/zJxWdXsbsKBUk2TC0BCPwMq5Q/CPvaJFkNS/1l1qUPe+uH3oD59erYGI/Y4sce6KaXYElAIOLt+0O3t2+/xJDF1XvOlWGC1W1B8VMszbGfOvT5qaRRAIFK3BCO164nZ0uYLH2YjNN8thXS2v2BK9gTfD7jHVxzHr4roOlEvYYz9QIz+Vl/sLDXInsctFsXjqIRnO2ZO387lxmIboLDZCJ59KLFliNIgh9ipt6tLg9SihpRPDO1ia5byw7de1aCQmF5geOQtK509rzfdwxaKOIq+73AvwCC5/5fcV4vo3+3LpMdtWHh0ywsJC/ZGoCb8/9D8F/ifgLLl8S8QWfU8cAAAAASUVORK5CYII=">
2323
</p>
@@ -74,7 +74,7 @@ We'd love your help! Use tags [up-for-grabs][up-for-grabs-issues] and [good firs
7474
### Thanks to all the people who already contributed
7575

7676
<a href="https://github.com/open-telemetry/opentelemetry-js-contrib/graphs/contributors">
77-
<img src="https://contributors-img.web.app/image?repo=open-telemetry/opentelemetry-js-contrib" />
77+
<img alt="contributors" src="https://contributors-img.web.app/image?repo=open-telemetry/opentelemetry-js-contrib" />
7878
</a>
7979

8080
## Useful links

‎detectors/node/opentelemetry-resource-detector-alibaba-cloud/CHANGELOG.md

-72
Original file line numberDiff line numberDiff line change
@@ -1,77 +1,5 @@
11
# Changelog
22

3-
### Dependencies
4-
5-
* The following workspace dependencies were updated
6-
* devDependencies
7-
* @opentelemetry/contrib-test-utils bumped from ^0.30.0 to ^0.31.0
8-
9-
### Dependencies
10-
11-
* The following workspace dependencies were updated
12-
* devDependencies
13-
* @opentelemetry/contrib-test-utils bumped from ^0.31.0 to ^0.32.0
14-
15-
### Dependencies
16-
17-
* The following workspace dependencies were updated
18-
* devDependencies
19-
* @opentelemetry/contrib-test-utils bumped from ^0.32.0 to ^0.33.0
20-
21-
### Dependencies
22-
23-
* The following workspace dependencies were updated
24-
* devDependencies
25-
* @opentelemetry/contrib-test-utils bumped from ^0.33.0 to ^0.33.1
26-
27-
### Dependencies
28-
29-
* The following workspace dependencies were updated
30-
* devDependencies
31-
* @opentelemetry/contrib-test-utils bumped from ^0.33.1 to ^0.33.2
32-
33-
### Dependencies
34-
35-
* The following workspace dependencies were updated
36-
* devDependencies
37-
* @opentelemetry/contrib-test-utils bumped from ^0.33.3 to ^0.33.4
38-
39-
### Dependencies
40-
41-
* The following workspace dependencies were updated
42-
* devDependencies
43-
* @opentelemetry/contrib-test-utils bumped from ^0.34.1 to ^0.34.2
44-
45-
### Dependencies
46-
47-
* The following workspace dependencies were updated
48-
* devDependencies
49-
* @opentelemetry/contrib-test-utils bumped from ^0.34.2 to ^0.34.3
50-
51-
### Dependencies
52-
53-
* The following workspace dependencies were updated
54-
* devDependencies
55-
* @opentelemetry/contrib-test-utils bumped from ^0.34.3 to ^0.35.0
56-
57-
### Dependencies
58-
59-
* The following workspace dependencies were updated
60-
* devDependencies
61-
* @opentelemetry/contrib-test-utils bumped from ^0.35.0 to ^0.35.1
62-
63-
### Dependencies
64-
65-
* The following workspace dependencies were updated
66-
* devDependencies
67-
* @opentelemetry/contrib-test-utils bumped from ^0.35.1 to ^0.36.0
68-
69-
### Dependencies
70-
71-
* The following workspace dependencies were updated
72-
* devDependencies
73-
* @opentelemetry/contrib-test-utils bumped from ^0.36.0 to ^0.37.0
74-
753
## [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)
764

775

‎detectors/node/opentelemetry-resource-detector-aws/CHANGELOG.md

-66
Original file line numberDiff line numberDiff line change
@@ -1,71 +1,5 @@
11
# Changelog
22

3-
### Dependencies
4-
5-
* The following workspace dependencies were updated
6-
* devDependencies
7-
* @opentelemetry/contrib-test-utils bumped from ^0.30.0 to ^0.31.0
8-
9-
### Dependencies
10-
11-
* The following workspace dependencies were updated
12-
* devDependencies
13-
* @opentelemetry/contrib-test-utils bumped from ^0.31.0 to ^0.32.0
14-
15-
### Dependencies
16-
17-
* The following workspace dependencies were updated
18-
* devDependencies
19-
* @opentelemetry/contrib-test-utils bumped from ^0.32.0 to ^0.33.0
20-
21-
### Dependencies
22-
23-
* The following workspace dependencies were updated
24-
* devDependencies
25-
* @opentelemetry/contrib-test-utils bumped from ^0.33.0 to ^0.33.1
26-
27-
### Dependencies
28-
29-
* The following workspace dependencies were updated
30-
* devDependencies
31-
* @opentelemetry/contrib-test-utils bumped from ^0.33.1 to ^0.33.2
32-
33-
### Dependencies
34-
35-
* The following workspace dependencies were updated
36-
* devDependencies
37-
* @opentelemetry/contrib-test-utils bumped from ^0.33.3 to ^0.33.4
38-
39-
### Dependencies
40-
41-
* The following workspace dependencies were updated
42-
* devDependencies
43-
* @opentelemetry/contrib-test-utils bumped from ^0.34.1 to ^0.34.2
44-
45-
### Dependencies
46-
47-
* The following workspace dependencies were updated
48-
* devDependencies
49-
* @opentelemetry/contrib-test-utils bumped from ^0.34.2 to ^0.34.3
50-
51-
### Dependencies
52-
53-
* The following workspace dependencies were updated
54-
* devDependencies
55-
* @opentelemetry/contrib-test-utils bumped from ^0.34.3 to ^0.35.0
56-
57-
### Dependencies
58-
59-
* The following workspace dependencies were updated
60-
* devDependencies
61-
* @opentelemetry/contrib-test-utils bumped from ^0.35.0 to ^0.35.1
62-
63-
### Dependencies
64-
65-
* The following workspace dependencies were updated
66-
* devDependencies
67-
* @opentelemetry/contrib-test-utils bumped from ^0.35.1 to ^0.36.0
68-
693
## [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)
704

715

‎detectors/node/opentelemetry-resource-detector-azure/CHANGELOG.md

+1-13
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,5 @@
11
# Changelog
22

3-
### Dependencies
4-
5-
* The following workspace dependencies were updated
6-
* devDependencies
7-
* @opentelemetry/contrib-test-utils bumped from ^0.35.1 to ^0.36.0
8-
9-
### Dependencies
10-
11-
* The following workspace dependencies were updated
12-
* devDependencies
13-
* @opentelemetry/contrib-test-utils bumped from ^0.36.0 to ^0.37.0
14-
153
## [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)
164

175

@@ -84,7 +72,7 @@
8472
* devDependencies
8573
* @opentelemetry/contrib-test-utils bumped from ^0.34.1 to ^0.34.3
8674

87-
## [0.1.0]() ()
75+
## 0.1.0
8876

8977
### Features
9078

‎detectors/node/opentelemetry-resource-detector-azure/README.md

+10
Original file line numberDiff line numberDiff line change
@@ -75,3 +75,13 @@ This package implements Semantic Convention [Version 1.19.0](https://github.com/
7575
- For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
7676
- For more about OpenTelemetry JavaScript: <https://github.com/open-telemetry/opentelemetry-js>
7777
- For help or feedback on this project, join us in [GitHub Discussions][discussions-url]
78+
79+
## License
80+
81+
Apache 2.0 - See [LICENSE][license-url] for more information.
82+
83+
[discussions-url]: https://github.com/open-telemetry/opentelemetry-js/discussions
84+
[license-url]: https://github.com/open-telemetry/opentelemetry-js-contrib/blob/main/LICENSE
85+
[license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat
86+
[npm-url]: https://www.npmjs.com/package/@opentelemetry/resource-detector-azure
87+
[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fresource-detector-azure.svg

‎detectors/node/opentelemetry-resource-detector-container/CHANGELOG.md

-60
Original file line numberDiff line numberDiff line change
@@ -1,65 +1,5 @@
11
# Changelog
22

3-
### Dependencies
4-
5-
* The following workspace dependencies were updated
6-
* devDependencies
7-
* @opentelemetry/contrib-test-utils bumped from ^0.30.0 to ^0.31.0
8-
9-
### Dependencies
10-
11-
* The following workspace dependencies were updated
12-
* devDependencies
13-
* @opentelemetry/contrib-test-utils bumped from ^0.32.0 to ^0.33.0
14-
15-
### Dependencies
16-
17-
* The following workspace dependencies were updated
18-
* devDependencies
19-
* @opentelemetry/contrib-test-utils bumped from ^0.33.0 to ^0.33.1
20-
21-
### Dependencies
22-
23-
* The following workspace dependencies were updated
24-
* devDependencies
25-
* @opentelemetry/contrib-test-utils bumped from ^0.33.1 to ^0.33.2
26-
27-
### Dependencies
28-
29-
* The following workspace dependencies were updated
30-
* devDependencies
31-
* @opentelemetry/contrib-test-utils bumped from ^0.33.3 to ^0.33.4
32-
33-
### Dependencies
34-
35-
* The following workspace dependencies were updated
36-
* devDependencies
37-
* @opentelemetry/contrib-test-utils bumped from ^0.34.2 to ^0.34.3
38-
39-
### Dependencies
40-
41-
* The following workspace dependencies were updated
42-
* devDependencies
43-
* @opentelemetry/contrib-test-utils bumped from ^0.34.3 to ^0.35.0
44-
45-
### Dependencies
46-
47-
* The following workspace dependencies were updated
48-
* devDependencies
49-
* @opentelemetry/contrib-test-utils bumped from ^0.35.0 to ^0.35.1
50-
51-
### Dependencies
52-
53-
* The following workspace dependencies were updated
54-
* devDependencies
55-
* @opentelemetry/contrib-test-utils bumped from ^0.35.1 to ^0.36.0
56-
57-
### Dependencies
58-
59-
* The following workspace dependencies were updated
60-
* devDependencies
61-
* @opentelemetry/contrib-test-utils bumped from ^0.36.0 to ^0.37.0
62-
633
## [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)
644

655

‎detectors/node/opentelemetry-resource-detector-container/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -51,3 +51,5 @@ Apache 2.0 - See [LICENSE][license-url] for more information.
5151
[discussions-url]: https://github.com/open-telemetry/opentelemetry-js/discussions
5252
[license-url]: https://github.com/open-telemetry/opentelemetry-js-contrib/blob/main/LICENSE
5353
[license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat
54+
[npm-url]: https://www.npmjs.com/package/@opentelemetry/resource-detector-container
55+
[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fresource-detector-container.svg

0 commit comments

Comments
 (0)