ci(docs): add llama-stack version to distro docs#53
ci(docs): add llama-stack version to distro docs#53mergify[bot] merged 1 commit intoopendatahub-io:mainfrom
Conversation
nathan-weinberg
requested review from
Elbehery,
VaishnaviHire,
cdoern,
derekhiggins,
leseb,
rhdedgar,
rhuss and
skamenan7
as code owners
WalkthroughAdds a documentation line about upstream Llama Stack v0.2.22 and updates Changes
Sequence Diagram(s)sequenceDiagram
participant Dev as Developer
participant Script as gen_distro_docs.py
participant Helper as extract_llama_stack_version()
participant File as distribution/Containerfile
participant Out as Generated Docs
Dev->>Script: Run script
Script->>Helper: Request Llama Stack version
Helper->>File: Read content
alt Version found
File-->>Helper: Content with llama-stack==X.Y.Z
Helper-->>Script: Return version X.Y.Z
Script->>Out: Generate header with versioned link
Note right of Out: Header includes extracted version
else Missing file / read error / no match
File-->>Helper: Error / No match
Helper-->>Script: Exit / raise error with message
Script-->>Dev: Terminate with explicit error message
end
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches
🧪 Generate unit tests
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (2)
🧰 Additional context used🧠 Learnings (2)📓 Common learnings📚 Learning: 2025-09-15T14:25:54.837ZApplied to files:
⏰ 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)
🔇 Additional comments (5)
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. 🧪 Early access (Sonnet 4.5): enabledWe are currently testing the Sonnet 4.5 model, which is expected to improve code review quality. However, this model may lead to increased noise levels in the review comments. Please disable the early access features if the noise level causes any inconvenience. Note:
Comment |
nathan-weinberg
force-pushed
the
enhance-docs
branch
from
b7b1469 to
9ee0af3
Compare
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
scripts/gen_distro_docs.py (1)
25-32: Broaden the version matcher.Line 25 limits matches to strictly numeric
X.Y.Z. If the Containerfile ever pins a pre-release (0.3.0rc1), post-release (0.3.0.post1), or local build tag, the generator exits even though the pin is valid. Please widen the pattern to accept the wider PEP 440 surface (e.g., allow alphanumerics, hyphen, plus) so doc generation keeps working after routine version bumps.Apply something like:
- pattern = r"llama-stack==([0-9]+\.[0-9]+\.[0-9]+)" + pattern = r"llama-stack==([0-9A-Za-z\.\-+]+)"
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
distribution/README.md(1 hunks)scripts/gen_distro_docs.py(2 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: nathan-weinberg
PR: opendatahub-io/llama-stack-distribution#33
File: distribution/Containerfile:17-21
Timestamp: 2025-09-15T14:25:54.837Z
Learning: In the opendatahub-io/llama-stack-distribution repository, the distribution/Containerfile is auto-generated by distribution/build.py based on configuration in build.yaml. When providers are added to build.yaml, the build script automatically regenerates the Containerfile with the required dependencies. Changes to the Containerfile should not be flagged as manual edits if they correspond to legitimate changes in the build configuration.
📚 Learning: 2025-09-15T14:25:54.837Z
Learnt from: nathan-weinberg
PR: opendatahub-io/llama-stack-distribution#33
File: distribution/Containerfile:17-21
Timestamp: 2025-09-15T14:25:54.837Z
Learning: In the opendatahub-io/llama-stack-distribution repository, the distribution/Containerfile is auto-generated by distribution/build.py based on configuration in build.yaml. When providers are added to build.yaml, the build script automatically regenerates the Containerfile with the required dependencies. Changes to the Containerfile should not be flagged as manual edits if they correspond to legitimate changes in the build configuration.
Applied to files:
distribution/README.mdscripts/gen_distro_docs.py
⏰ 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-test-push (linux/amd64)
- GitHub Check: Summary
🔇 Additional comments (1)
distribution/README.md (1)
7-8: Version callout aligns with generated docs.Line 7 cleanly surfaces the current upstream release and keeps the generated README in sync with the script output. Looks good to me.
Signed-off-by: Nathan Weinberg <[email protected]>
nathan-weinberg
force-pushed
the
enhance-docs
branch
from
9ee0af3 to
1498da9
Compare
|
LGTM, Nathan. Thanks. |
nathan-weinberg
removed request for
Elbehery,
VaishnaviHire,
leseb,
rhdedgar and
rhuss
4 participants
What does this PR do?
Adds the current Llama Stack version being used in the container to the docs
Test Plan
Take a look!
Summary by CodeRabbit