search

open-telemetry / opentelemetry-ruby-contrib

Contrib Packages for the OpenTelemetry Ruby API and SDK implementation.
https://opentelemetry.io
Apache License 2.0
80 stars 169 forks source link

Generate project metadata documentation via automation #916

Open kaylareopelle opened 6 months ago

kaylareopelle commented 6 months ago

To disambiguate a code "owner" vs the reviewers, create an automated strategy to display a more specific code owner on a gem's Readme.

One option coudl be to follow the pattern established in otelcol-contrib where the Readme files have an auto-generated section:

Status
Stability [beta]: traces, metrics, logs
Distributions [contrib], [observiq], [splunk], [sumo]
Issues Open issues Closed issues
Code Owners @rnishtala-sumo

First discussed in: https://github.com/open-telemetry/opentelemetry-ruby-contrib/pull/879#discussion_r1496463167

Here's an example PR demonstrating how this is done: https://github.com/open-telemetry/opentelemetry-collector-contrib/pull/22800

It uses the mdatagen library, which isn't available in Ruby.

dmathieu commented 6 months ago

Note that while mdatagen is written in Go, and the documentation emphasizes the usage of //go:generate, it is actually only a binary that doesn't need a .go file to be executed. It could be used within this repository rather easily, we'd just need to go install the binary in a pre-step.

github-actions[bot] commented 5 months ago

👋 This issue has been marked as stale because it has been open with no activity. You can: comment on the issue or remove the stale label to hold stale off for a while, add the keep label to hold stale off permanently, or do nothing. If you do nothing this issue will be closed eventually by the stale bot.