Add compatibility matrix for llama-stack-provider-ragas

[dmaniloff]

This new document outlines the compatibility of the provider with various versions of llama-stack, including a version compatibility table and recommended versions for specific llama-stack targets.

Summary by Sourcery

Document version compatibility and recommended provider versions for llama-stack-provider-ragas.

Documentation:

• Add a COMPATIBILITY.md file describing supported llama-stack, Python, and release branch combinations for each provider version.
• Document recommended provider versions for targeting specific llama-stack releases.

[sourcery-ai]

Reviewer's Guide

Adds a new COMPATIBILITY.md document that formalizes and documents the version compatibility matrix between llama-stack-provider-ragas and various llama-stack generations, including release-branch alignment, a detailed version table, and concrete recommended provider versions for specific llama-stack targets.

Flow diagram for selecting provider version based on llama-stack target

flowchart TD
  A[Start] --> B[Determine_llama_stack_version]
  B --> C{llama_stack_version_major}
  C -->|0.5.x_or_higher| D[Use_provider_version_>=_0.6.0]
  C -->|0.4.x| E[Use_provider_version_==_0.5.4]
  C -->|0.3.x| F[Use_provider_version_==_0.4.3]
  C -->|0.2.x_or_older| G[Use_legacy_provider_from_version_table]

  D --> H[Install_with_pip_install_llama_stack_provider_ragas_>=_0.6.0]
  E --> I[Install_with_pip_install_llama_stack_provider_ragas_==_0.5.4]
  F --> J[Install_with_pip_install_llama_stack_provider_ragas_==_0.4.3]
  G --> K[Consult_version_compatibility_table_for_exact_match]

  H --> L[Verify_compatibility_in_runtime]
  I --> L
  J --> L
  K --> L
  L --> M[End]

Loading

File-Level Changes

Change	Details	Files
Introduce a compatibility matrix document describing provider–llama-stack version alignment and recommendations.	Add an overview explaining historical misalignment between provider versions and llama-stack generations and the new release-branch scheme starting from provider 0.5.4. Document a release-branch matrix mapping provider release branches to their intended llama-stack target versions and provider version ranges. Add a detailed version compatibility table listing provider versions, corresponding llama-stack dependency constraints, Python requirements, branch associations, and legacy/maintenance status notes. Provide explicit recommended provider version selections for targeting llama-stack 0.5.x, 0.4.x, and 0.3.x, including example pip install commands.	COMPATIBILITY.md

Possibly linked issues

• #(unknown): The PR documents which RAGAS provider versions support llama-stack 0.2.23, directly addressing the compatibility preparation issue.

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey - I've found 1 issue

Prompt for AI Agents

Please address the comments from this code review:

## Individual Comments

### Comment 1
<location> `COMPATIBILITY.md:8-9` </location>
<code_context>
+
+## Important Note
+
+Prior to provider version 0.5.4, the provider versioning did not align to
+llama-stack version generations. For example, provider versions 0.4.x and
+0.5.0–0.5.1 all targeted llama-stack 0.2.x/0.3.x despite spanning two
+provider major-minor lines. Starting with provider 0.5.4, the release
</code_context>

<issue_to_address>
**suggestion (typo):** Consider rephrasing "did not align to llama-stack version generations" for more natural wording.

Consider changing this to "did not align with llama-stack version generations" or simply "did not align with llama-stack versions" for more natural wording.

```suggestion
Prior to provider version 0.5.4, the provider versioning did not align with
llama-stack versions. For example, provider versions 0.4.x and
```
</issue_to_address>

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}