Skip to content

Conversation

@tisnik
Copy link
Contributor

@tisnik tisnik commented Sep 17, 2025

Description

LCORE-634: update Llama Stack version in documentation

Type of change

  • Refactor
  • New feature
  • Bug fix
  • CVE fix
  • Optimization
  • Documentation Update
  • Configuration Update
  • Bump-up service version
  • Bump-up dependent library
  • Bump-up library or tool used for development (does not change the final image)
  • CI configuration change
  • Konflux configuration change
  • Unit tests improvement
  • Integration tests improvement
  • End to end tests improvement

Related Tickets & Documents

  • Related Issue #LCORE-634

Summary by CodeRabbit

  • Documentation

    • Updated docs and examples to reference version 0.2.20 (getting started, deployment guide, output, OpenAPI docs).
    • Clarified FeedbackRequest usage: categories now shown as enum values (e.g., FeedbackCategory.INCORRECT, FeedbackCategory.INCOMPLETE) instead of raw strings.
  • Chores

    • Bumped example dependency to llama-stack 0.2.20 in configuration snippets.
  • Tests

    • Updated end-to-end test expectations to reflect version 0.2.20.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 17, 2025

Walkthrough

Version references updated from 0.2.19/0.2.18 to 0.2.20 across README, docs, examples, and tests. docs/openapi.md changes example usage of FeedbackRequest.categories from strings to FeedbackCategory enum values, and updates enum naming. No runtime code changes.

Changes

Cohort / File(s) Summary of Changes
Version string bump to 0.2.20
README.md, docs/deployment_guide.md, docs/getting_started.md, docs/openapi.json, docs/output.md, examples/pyproject.llamastack.toml, src/models/responses.py, tests/e2e/features/info.feature
Updated llama-stack version references to 0.2.20 in docs, examples, and one test expectation.
API docs: FeedbackRequest categories enum
docs/openapi.md
Example updated: categories now shown as List[FeedbackCategory] instead of List[str]; enum usage changed to uppercase values (e.g., FeedbackCategory.INCORRECT, FeedbackCategory.INCOMPLETE). Also updates example llama_stack_version to 0.2.20.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested reviewers

  • umago

Poem

A hop, a bump—now 0.2.20 sings,
My whiskers twitch at versioned things.
Enums bloom where strings once grew,
Feedback fields now crisp and true.
I stamp my paw, release the cheer—
Docs aligned, the path is clear! 🐇✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title "LCORE-634: update Llama Stack version in documentation" is concise, a single sentence, and accurately summarizes the primary change (a documentation-only version bump); including the issue key is appropriate and the title avoids extraneous detail or file lists, so a teammate scanning history will understand the main intent.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

  • Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
  • Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (3)
src/models/responses.py (1)

95-96: Keep examples consistent: include 0.2.20 in field examples and example block

Minor consistency tweak so all examples reflect the new version.

Apply:

@@
         info_response = InfoResponse(
             name="Lightspeed Stack",
             service_version="1.0.0",
-            llama_stack_version="0.2.20",
+            llama_stack_version="0.2.20",
         )
@@
     llama_stack_version: str = Field(
         description="Llama Stack version",
-        examples=["0.2.1", "0.2.2", "0.2.18"],
+        examples=["0.2.1", "0.2.2", "0.2.20"],
     )
@@
                 {
                     "name": "Lightspeed Stack",
                     "service_version": "1.0.0",
-                    "llama_stack_version": "1.0.0",
+                    "llama_stack_version": "0.2.20",
                 }

Also applies to: 110-113, 120-123

docs/openapi.json (1)

1719-1720: OpenAPI examples: finish the version sweep in schemas

The description example was updated; mirror this in the property examples and top-level examples for consistency.

Apply:

@@
                     "llama_stack_version": {
                         "type": "string",
                         "title": "Llama Stack Version",
                         "description": "Llama Stack version",
-                        "examples": [
-                            "0.2.1",
-                            "0.2.2",
-                            "0.2.18"
-                        ]
+                        "examples": ["0.2.1", "0.2.2", "0.2.20"]
                     }
@@
-                "examples": [
-                    {
-                        "llama_stack_version": "1.0.0",
-                        "name": "Lightspeed Stack",
-                        "service_version": "1.0.0"
-                    }
-                ]
+                "examples": [
+                    {
+                        "name": "Lightspeed Stack",
+                        "service_version": "1.0.0",
+                        "llama_stack_version": "0.2.20"
+                    }
+                ]

Also applies to: 1706-1709, 1721-1725

docs/deployment_guide.md (1)

393-394: Missed occurrences: still mention 0.2.18 elsewhere in this guide

A few leftover references should also be updated to 0.2.20.

Apply:

@@
-  "version": "0.2.18"
+  "version": "0.2.20"
@@
-        "llama-stack==0.2.18",
+        "llama-stack==0.2.20",
@@
-  "version": "0.2.18"
+  "version": "0.2.20"

Also applies to: 673-679, 1073-1075

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a41535d and d638c48.

📒 Files selected for processing (9)
  • README.md (1 hunks)
  • docs/deployment_guide.md (1 hunks)
  • docs/getting_started.md (1 hunks)
  • docs/openapi.json (1 hunks)
  • docs/openapi.md (2 hunks)
  • docs/output.md (1 hunks)
  • examples/pyproject.llamastack.toml (1 hunks)
  • src/models/responses.py (1 hunks)
  • tests/e2e/features/info.feature (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
  • GitHub Check: build-pr
  • GitHub Check: e2e_tests
🔇 Additional comments (8)
docs/openapi.md (3)

782-782: LGTM! Enhanced feedback model with enum values.

The change from string-based categories to FeedbackCategory enum values improves type safety and provides better validation for feedback categorization. The example correctly demonstrates the new enum usage.


910-910: Version update correctly applied.

The Llama Stack version has been properly updated from "0.2.19" to "0.2.20" in the InfoResponse example, consistent with the PR objectives.


740-751: FeedbackCategory casing is consistent — no changes required.
Enum members are uppercase (FeedbackCategory.INCORRECT / NOT_RELEVANT / INCOMPLETE) and map to lowercase string values ("incorrect", "not_relevant", "incomplete"); code/tests use the enum members and API/docs use the lowercase payload strings as appropriate.

docs/getting_started.md (1)

27-27: LGTM: version pin updated to 0.2.20

docs/output.md (1)

901-901: LGTM: InfoResponse example updated to 0.2.20

README.md (1)

248-248: LGTM: pyproject snippet pinned to 0.2.20

examples/pyproject.llamastack.toml (1)

7-7: LGTM: dependency bump to 0.2.20

tests/e2e/features/info.feature (1)

21-21: Pin CI to llama-stack 0.2.20 or relax the E2E version assertion

Repo shows MINIMAL_SUPPORTED_LLAMA_STACK_VERSION = "0.2.17" and MAXIMAL_SUPPORTED_LLAMA_STACK_VERSION = "0.2.20" (src/constants.py). The test at tests/e2e/features/info.feature:21 asserts the exact string "llama-stack version 0.2.20" and will fail if CI runs 0.2.19.

  • Option A: Pin the e2e/CI environment to llama-stack 0.2.20.
  • Option B (preferred): Change the test to accept the supported range (check version ∈ [MINIMAL_SUPPORTED_LLAMA_STACK_VERSION, MAXIMAL_SUPPORTED_LLAMA_STACK_VERSION]) or assert only major.minor; see src/utils/llama_stack_version.py for the compare helper.

@tisnik tisnik merged commit cb1cf35 into lightspeed-core:main Sep 17, 2025
18 of 19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant