[🤖] Update Supported Versions

[TonyCTHsu]

This is a PR to update the table for supported integration versions.
The supported versions markdown is generated from the minimum and maximum tested versions of each integration,
as defined from the gemfile.lock gem declarations.

Workflow run: Generate Supported Versions

This should be tied to tracer releases, or triggered manually.

[github-actions]

👋 Hey @DataDog/ruby-guild, please fill "Change log entry" section in the pull request description.

If changes need to be present in CHANGELOG.md you can state it this way

**Change log entry**

Yes. A brief summary to be placed into the CHANGELOG.md

(possible answers Yes/Yep/Yeah)

Or you can opt out like that

**Change log entry**

None.

(possible answers No/Nope/None)

^{Visited at: 2025-01-28 20:27:19 UTC}

[datadog-datadog-prod-us1]

Datadog Report

Branch report: auto-generate/update-supported-versions
Commit report: 475c6f5
Test service: dd-trace-rb

❌ 1 Failed (0 Known Flaky), 22056 Passed, 1476 Skipped, 5m 47.39s Total Time

❌ Failed Tests (1)

• gem release process datadog.gemspec files includes all important files - rspec - Details

  Expand for error

   the missing elements were:      ["gem_output.json", "integration_versions.md"]
   
   Failure/Error:
     expect(gemspec.files)
       .to match_array(
         \`git ls-files -z\`
           .split("\x0")
           .reject { |f| f.match(directories_excluded) }
           .reject { |f| f.match(single_files_excluded) }
       )
   ...
  

[pr-commenter]

Benchmarks

Benchmark execution time: 2025-01-28 21:54:02

Comparing candidate commit b047cd3 in PR branch auto-generate/update-supported-versions with baseline commit 8dba6cb in branch master.

Found 0 performance improvements and 0 performance regressions! Performance is the same for 31 metrics, 2 unstable metrics.

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.73%. Comparing base (8dba6cb) to head (726fe31).

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #4236      +/-   ##
==========================================
+ Coverage   97.72%   97.73%   +0.01%     
==========================================
  Files        1368     1368              
  Lines       82997    82997              
  Branches     4219     4219              
==========================================
+ Hits        81105    81114       +9     
+ Misses       1892     1883       -9     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[bouwkast]

Just a question on Net::HTTP as I think the versions we're reporting are actually http.rb

[datadog-datadog-prod-us1]

Datadog Report

Branch report: auto-generate/update-supported-versions
Commit report: b047cd3
Test service: dd-trace-rb

✅ 0 Failed, 22109 Passed, 1477 Skipped, 5m 59.27s Total Time

[p-datadog]

Both of the added files are unclear as to their contents, purpose and how they come to be:

gem_output.json provides no hints/explanation as to what it contains or where it came from.

The markdown file, if it's meant for consumption by humans, I think should have some prose in it describing its contents. If it's not meant for consumption by humans, perhaps it should be in some other format.

[p-datadog]

Both of the added files are unclear as to their contents, purpose and how they come to be:

gem_output.json provides no hints/explanation as to what it contains or where it came from.

The markdown file, if it's meant for consumption by humans, I think should have some prose in it describing its contents. If it's not meant for consumption by humans, perhaps it should be in some other format.

[marcotc]

Can we add a markdown comment to the top of the file saying it was generated from .github/scripts/generate_table_versions.rb?

[bouwkast]

Both of the added files are unclear as to their contents, purpose and how they come to be:

gem_output.json provides no hints/explanation as to what it contains or where it came from.

The markdown file, if it's meant for consumption by humans, I think should have some prose in it describing its contents. If it's not meant for consumption by humans, perhaps it should be in some other format.

@p-datadog thanks!
For how they came to be the workflow run that generates the files is in the PR description, but maybe it'd be clearer to go with @marcotc's suggestion to add a comment at the top of both files about what generates them to make it more obvious.

gem_output.json is the "machine"-readable format of the markdown table, maybe it isn't entirely necessary @quinna-h? The level of care though is low there in my opinion, but we've made a machine-readable format of this in other repositories to allow different output formats and allow for some querying.

The markdown file is definitely meant for human consumption. What other format would work better? Note that at the end of the quarter these will be sourced onto the public documentation replacing this table: https://docs.datadoghq.com/tracing/trace_collection/compatibility/ruby#integrations

Note that we will still need to (likely hard code) the configuration options over.

@quinna-h could we add a sentence at the top:

For a list of available integrations, and their supported version ranges, refer to the following:

[marcotc]

The markdown file is definitely meant for human consumption. What other format would work better? Note that at the end of the quarter these will be sourced onto the public documentation replacing this table: docs.datadoghq.com/tracing/trace_collection/compatibility/ruby#integrations

The public docs page https://docs.datadoghq.com/tracing/trace_collection/compatibility/ruby/ is sourced from https://github.com/DataDog/dd-trace-rb/blob/fe9272b14743e9af065f71cd9ef71181f1086d89/docs/Compatibility.md.
One way we accomplish the goal to have it published by the end of the quarter is to merge the result from docs/integration_versions.md into the # Integrations portion of Compatibility.md:

dd-trace-rb/docs/Compatibility.md

Line 64 in fe9272b

## Integrations

For example, we can rename Compatibility.md to Compatibility.template.md, and delete the content from the Integrations section:

## Integrations

- For a list of available integrations, and their configuration options, refer to the following:
+ [GENERATED_INTEGRATION_VERSIONS_PLACEHOLDER]
- ...

The GitHub action you wrote would then render the real Compatibility.md, replacing [GENERATED_INTEGRATION_VERSIONS_PLACEHOLDER] with the real value. Users could then manually update Compatibility.template.md if needed, to update other sections.