chore: add script to verify READMEs and apply few fixes #2242
Conversation
This file contains 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
github-actions
bot
assigned aabmass, blumamir, hectorhdzg, JamieDanielson, legendecas, martinkuba, maryliag, mottibec, naseemkullah and obecny
github-actions
bot
added
pkg:instrumentation-ioredis
pkg:instrumentation-graphql
pkg:instrumentation-fs
pkg:instrumentation-restify
pkg:instrumentation-dns
pkg:resource-detector-alibaba-cloud
pkg:resource-detector-gcp
pkg:instrumentation-amqplib
pkg:instrumentation-lru-memoizer
pkg:instrumentation-mongoose
pkg:instrumentation-aws-lambda
pkg:instrumentation-aws-sdk
pkg:instrumentation-cassandra-driver
pkg:instrumentation-connect
pkg:instrumentation-express
pkg:instrumentation-fastify
pkg:instrumentation-generic-pool
labels
github-actions
bot
added
pkg:instrumentation-router
pkg:instrumentation-winston
pkg:instrumentation-document-load
pkg:instrumentation-long-task
pkg:instrumentation-user-interaction
pkg:plugin-react-load
pkg:instrumentation-socket.io
pkg:instrumentation-cucumber
pkg:resource-detector-container
pkg:resource-detector-azure
labels
blumamir
commented
May 25, 2024
Comment on lines
86
to
87
| [pkg-repo-url]: https://github.com/nestjs/nest | ||
| [pkg-npm-url]: https://www.npmjs.com/package/@nestjs/core |
There was a problem hiding this comment.
these were not used in the readme
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2242 +/- ##
==========================================
- Coverage 90.97% 90.30% -0.68%
==========================================
Files 146 147 +1
Lines 7492 7263 -229
Branches 1502 1509 +7
==========================================
- Hits 6816 6559 -257
- Misses 676 704 +28 |
|
It would be really nice if this also had an option of |
maryliag
approved these changes
May 27, 2024
trentm
approved these changes
May 31, 2024
detectors/node/opentelemetry-resource-detector-container/README.md
Outdated
Show resolved
Hide resolved
JamieDanielson
approved these changes
Jun 19, 2024
trentm
approved these changes
Jun 19, 2024
blumamir
added a commit
to blumamir/opentelemetry-js-contrib
that referenced
this pull request
Jun 22, 2024
…ry#2242) * chore: add script to verify README for instrumentations * ci: add verify readmes to lint workflow * chore: md lint * fix: ci lint step * revert: README changes to detectors * refactor: rename verify-readme to lint-readme * fix: remove console log on success * refactor: use auto instrumentations deps to lable node or web * Update scripts/lint-readme.js Co-authored-by: Trent Mick <[email protected]> --------- Co-authored-by: Trent Mick <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
I am looking into opportunities to improve how we manage READMEs.
This PR adds a script to verify few peaces of instrumentation README, as well as introducing few fixes where the content was wrong, missing, or not consistent with other packages.
Currently, this is done for instrumentation packages, but can be extended to other packages later on