docs(deployment): pin image version in Kubernetes example#222
docs(deployment): pin image version in Kubernetes example#222andrerfneves wants to merge 1 commit into
Conversation
Change image: lightning-decoder:latest to image: lightning-decoder:0.7.1 in the Kubernetes Deployment manifest example. Using :latest in Kubernetes manifests is an anti-pattern because it makes deployments non-reproducible and can cause unexpected version changes on pod restarts. Pinning to a specific version tag follows container best practices and is consistent with the project's versioning.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 9ba19784ef
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| containers: | ||
| - name: lightning-decoder | ||
| image: lightning-decoder:latest | ||
| image: lightning-decoder:0.7.1 # Update to match your built image version |
There was a problem hiding this comment.
When readers follow this page, the documented build commands tag the image as lightning-decoder (which Docker treats as lightning-decoder:latest; Docker's image reference docs state, "If no tag is provided, Docker defaults to latest"). This manifest now references lightning-decoder:0.7.1, so applying it after the documented build steps will look for a tag the instructions never create or push, causing image pull failures unless the reader manually retags the image; either update the build/push examples to create :0.7.1 or keep this manifest aligned with the tag those steps produce.
Useful? React with 👍 / 👎.
1 participant
Summary
Pins the container image tag from
:latestto a specific version in the Kubernetes Deployment manifest example inDEPLOYMENT_DOCKER.md.Why
The example used
image: lightning-decoder:latest, which is a well-known anti-pattern for Kubernetes manifests::latestdoesn't indicate which version is actually runningPinning to
0.7.1(the current project version) demonstrates the correct pattern while still being a simple, copyable example.Changes
DEPLOYMENT_DOCKER.md: Changedimage: lightning-decoder:latest→image: lightning-decoder:0.7.1in the Kubernetes Deployment manifestTest Plan
package.jsonversion