-
Notifications
You must be signed in to change notification settings - Fork 54
LCORE-634: update Llama Stack version in documentation #553
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
LCORE-634: update Llama Stack version in documentation #553
Conversation
WalkthroughVersion 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
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches
🧪 Generate unit tests
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.
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. Comment |
There was a problem hiding this 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 blockMinor 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 schemasThe 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 guideA 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
📒 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
FeedbackCategoryenum 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.20docs/output.md (1)
901-901: LGTM: InfoResponse example updated to 0.2.20README.md (1)
248-248: LGTM: pyproject snippet pinned to 0.2.20examples/pyproject.llamastack.toml (1)
7-7: LGTM: dependency bump to 0.2.20tests/e2e/features/info.feature (1)
21-21: Pin CI to llama-stack 0.2.20 or relax the E2E version assertionRepo 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.
Description
LCORE-634: update Llama Stack version in documentation
Type of change
Related Tickets & Documents
Summary by CodeRabbit
Documentation
Chores
Tests