Migrate code-excerpts tooling to npm package version#9638
Merged
chalin merged 2 commits intoopen-telemetry:mainfrom Apr 13, 2026
Merged
Migrate code-excerpts tooling to npm package version#9638chalin merged 2 commits intoopen-telemetry:mainfrom
chalin merged 2 commits intoopen-telemetry:mainfrom
Conversation
github-actions
bot
added
dependencies
otelbot-docs
bot
added
missing:docs-approval
3 tasks
Replace the Dart-based code excerpt tooling with a Node-based code-excerpter package. Removed the tools/ Dart files and symlinks (README, build.yaml, pubspec.yaml, and tools/content/*), added the code-excerpter dependency, and introduced an internal _code-excerpter-over-en script. Add explicit npm scripts: check:code-excerpts and fix:code-excerpts (and keep a deprecated alias for code-excerpts that warns and forwards to fix), and updated package.json scripts accordingly. Also updated docs and site content: added "excerpter" to cspell words, refreshed npm-scripts.md to document the deprecation and new commands, and adjusted Java getting-started snippets to clean up prettier/markdownlint comment markers around code excerpts.
chalin
force-pushed
the
chalin-m24-code-excerpter-ts-2026-0412
branch
from
deae16e to
cea7650
Compare
vitorvasc
approved these changes
Apr 13, 2026
otelbot-docs
bot
removed
the
missing:docs-approval
jack-berg
approved these changes
Apr 13, 2026
Member
jack-berg
left a comment
jack-berg
left a comment
There was a problem hiding this comment.
Nice - checked out this PR on my machine and played around with it a bit. Seems to work as expected.
otelbot-docs
bot
added
ready-to-be-merged
4 tasks
tiffany76
pushed a commit
to tiffany76/opentelemetry.io
that referenced
this pull request
Apr 13, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
content/en/docs/languages/java/getting-started.md, as an example of how usage will be simplified by using this new version of the tool<?code-excerpt...?>directives b/c I know you're working on them. If you would like me to clean up those files, let me know.tools/, which was in support of the Dart toolingcheck:code-excerptsfix:code-excerptscode-excerptsalias that prints a red deprecation noticecheck:code-excerptsintest:compound-testsso that it gets run in the Test PR checkcontent/en/site/build/npm-scripts.mdto document the new commands and the deprecated alias.content/en/docs/languages/java/getting-started.mdsnippet markup so excerpt-related Prettier/Markdownlint comment markers stay clean./cc @vitorvasc