Skip to content

infra: Introduce textlint to CI pipeline#4831

Merged
lmolkova merged 18 commits intoopen-telemetry:mainfrom
thompson-tomo:infra/textlint
Mar 24, 2026
Merged

infra: Introduce textlint to CI pipeline#4831
lmolkova merged 18 commits intoopen-telemetry:mainfrom
thompson-tomo:infra/textlint

Conversation

@thompson-tomo
Copy link
Copy Markdown
Contributor

@thompson-tomo thompson-tomo commented Jan 9, 2026

Closes #4728

Changes

This adds textlint into the CI pipeline to work alongside misspell/cspell.

TextLint will handle:

  • Automated text corrections
  • Casing corrections.

This is consistent with what OTEL.io does and addresses the ability to fix spelling issues via cli.

Note, the second commit is purely generated via the fix command for textlint and markdownlint. The textlint config file is take from otel.io.

For non-trivial changes, follow the change proposal process.

@thompson-tomo thompson-tomo force-pushed the infra/textlint branch 7 times, most recently from a700f5b to f03393d Compare January 9, 2026 01:59
@thompson-tomo thompson-tomo changed the title infra: Go through and setup textlint infra: Introduce textlint to pipeling Jan 9, 2026
@thompson-tomo thompson-tomo changed the title infra: Introduce textlint to pipeling infra: Introduce textlint to CI pipeline Jan 9, 2026
@thompson-tomo thompson-tomo marked this pull request as ready for review January 9, 2026 02:09
@thompson-tomo thompson-tomo requested review from a team as code owners January 9, 2026 02:09
@github-actions
Copy link
Copy Markdown

This PR was marked stale. It will be closed in 14 days without additional activity.

@github-actions github-actions Bot added the Stale label Jan 26, 2026
Copy link
Copy Markdown
Contributor Author

@thompson-tomo thompson-tomo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking for feedback on my comments to determine if we need additional rules.

Comment thread CHANGELOG.md Outdated
Comment thread CHANGELOG.md Outdated
Comment thread oteps/0066-separate-context-propagation.md Outdated
Comment thread oteps/0099-otlp-http.md
Comment thread oteps/0119-standard-system-metrics.md Outdated
Comment thread specification/context/env-carriers.md
Comment thread specification/context/env-carriers.md Outdated
Comment thread specification/metrics/data-model.md Outdated
Comment thread specification/metrics/data-model.md Outdated
Comment thread specification/metrics/data-model.md Outdated
@github-actions github-actions Bot removed the Stale label Feb 2, 2026
Copy link
Copy Markdown
Contributor

@jsuereth jsuereth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall - this looks great! Can you use it the same as other fix tools in the specification.

I added a few comments on "odd" renames I saw, in addition to agreeing with the ones called out.

What's your plan for these?

Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread oteps/0066-separate-context-propagation.md Outdated
Comment thread oteps/0152-telemetry-schemas.md Outdated
Comment thread oteps/0201-scope-attributes.md
Comment thread oteps/README.md Outdated
@thompson-tomo
Copy link
Copy Markdown
Contributor Author

thompson-tomo commented Feb 2, 2026

Can you use it the same as other fix tools in the specification.

Yes, currently if you run make fix it will perform the textlint corrections just like we were previously doing with misspell. I have also incorporated it into the make check command

I added a few comments on "odd" renames I saw, in addition to agreeing with the ones called out.

What's your plan for these?

For the ones which we are in agreement on, they will be added to the config as allowed and I will ensure they are changed back.

@thompson-tomo thompson-tomo force-pushed the infra/textlint branch 6 times, most recently from 298e42b to b4ea171 Compare February 3, 2026 01:22
@jmacd jmacd assigned jmacd and jsuereth and unassigned jmacd Feb 4, 2026
@thompson-tomo
Copy link
Copy Markdown
Contributor Author

@jsuereth i believe all open issues have been resolved with input from otel-comms on slack for the couple which we were not certain on. Could you take another look.

@thompson-tomo
Copy link
Copy Markdown
Contributor Author

@jsuereth can you take another look at this as I have actioned the open items. Note i have added both the textlint & textlint-correction make commands etc.

@jsuereth
Copy link
Copy Markdown
Contributor

jsuereth commented Mar 4, 2026

Thanks @thompson-tomo ! This looks great now.

@thompson-tomo
Copy link
Copy Markdown
Contributor Author

Ci issue fixed in #4913

@lmolkova lmolkova added this pull request to the merge queue Mar 24, 2026
Merged via the queue into open-telemetry:main with commit 2f5ac83 Mar 24, 2026
9 checks passed
@thompson-tomo thompson-tomo deleted the infra/textlint branch March 24, 2026 09:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Replace misspell with cspell

4 participants