Add Chart.yaml version comment for dynamic replacement#108
Add Chart.yaml version comment for dynamic replacement#108emsearcy merged 2 commits intolinuxfoundation:mainfrom
Conversation
- Add explanatory comment to Chart.yaml about dynamic version replacement during build process - Chart version remains at 0.0.1 and is dynamically replaced with release version during chart build job Related: LFXV2-872 🤖 Generated with [GitHub Copilot](https://github.com/features/copilot) (via Zed) Signed-off-by: Eric Searcy <eric@linuxfoundation.org>
|
Caution Review failedThe pull request is closed. WalkthroughAdded a single comment above the Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Tip Issue Planner is now in beta. Read the docs and try it out! Share your feedback on Discord. Comment |
There was a problem hiding this comment.
Pull request overview
This PR adds an inline comment to the Chart.yaml file to document that the version field should not be manually incremented, as it will be dynamically replaced with the actual release version during the chart build process.
Changes:
- Added a comment in Chart.yaml explaining that the version is dynamically replaced during the build process
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| # This version should not be incremented, as it is dynamically replaced with the release version during the chart build job. | ||
| version: 0.0.1 |
There was a problem hiding this comment.
The comment added in Chart.yaml states that the version should not be incremented and will be dynamically replaced during the chart build job. However, this contradicts the existing documentation in README.md (lines 112-113 and 135-136) which instructs developers to manually update the chart version in Chart.yaml. If the version is now dynamically replaced during the build process, the README.md should be updated to reflect this new workflow and remove instructions about manually updating the chart version.
Summary
This PR adds documentation to the Chart.yaml file explaining that the version is dynamically replaced during the chart build process.
Changes Made
0.0.1as expected and is dynamically replaced with the actual release version during chart build jobExpected Behavior
0.0.1with clear documentation that it shouldn't be manually incrementedhelm-chart-oci-publisheraction (already using correct version@17e4144d7ba68f7c3e8c16eece5aed15fd7c2dc8) dynamically replaces this version with the actual release versionRelated Issues