Skip to content

Add Chart.yaml version comment for dynamic replacement#108

Merged
emsearcy merged 2 commits intolinuxfoundation:mainfrom
emsearcy:LFXV2-872-chart-version-comments
Feb 19, 2026
Merged

Add Chart.yaml version comment for dynamic replacement#108
emsearcy merged 2 commits intolinuxfoundation:mainfrom
emsearcy:LFXV2-872-chart-version-comments

Conversation

@emsearcy
Copy link
Contributor

@emsearcy emsearcy commented Feb 3, 2026

Summary

This PR adds documentation to the Chart.yaml file explaining that the version is dynamically replaced during the chart build process.

Changes Made

  • Chart.yaml: Added explanatory comment about dynamic version replacement during build process
  • Version remains at 0.0.1 as expected and is dynamically replaced with the actual release version during chart build job

Expected Behavior

  • Chart.yaml version stays at 0.0.1 with clear documentation that it shouldn't be manually incremented
  • During release builds, the helm-chart-oci-publisher action (already using correct version @17e4144d7ba68f7c3e8c16eece5aed15fd7c2dc8) dynamically replaces this version with the actual release version
  • This ensures chart versions are always synchronized with application releases

Related Issues

  • Jira: LFXV2-872 - Tie chart releases to app releases

- 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>
@emsearcy emsearcy requested a review from a team as a code owner February 3, 2026 22:36
Copilot AI review requested due to automatic review settings February 3, 2026 22:36
@coderabbitai
Copy link

coderabbitai bot commented Feb 3, 2026

Caution

Review failed

The pull request is closed.

Walkthrough

Added a single comment above the version field in charts/lfx-platform/Chart.yaml stating the version is dynamically replaced during the build; no changes to the version value, dependencies, or runtime behavior.

Changes

Cohort / File(s) Summary
Helm Chart Configuration
charts/lfx-platform/Chart.yaml
Inserted a comment line above the version field indicating it is dynamically replaced during builds; no functional edits.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

  • linuxfoundation/lfx-v2-helm#108 — Adds the same comment above the version field in charts/lfx-platform/Chart.yaml about dynamic version replacement during build.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The PR title clearly describes the main change: adding a version comment to Chart.yaml for documentation purposes, which matches the actual changeset.
Description check ✅ Passed The PR description is directly related to the changeset, explaining the purpose of the added comment and expected behavior regarding dynamic version replacement.
Linked Issues check ✅ Passed The PR addresses LFXV2-872 by implementing the recommended practice of documenting that chart version is dynamically replaced, supporting the broader objective to tie chart releases to app releases.
Out of Scope Changes check ✅ Passed The changeset is narrowly scoped to adding a single documentation comment in Chart.yaml with no other modifications, staying within the scope of LFXV2-872.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Tip

Issue Planner is now in beta. Read the docs and try it out! Share your feedback on Discord.


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

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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.

Comment on lines +8 to 9
# This version should not be incremented, as it is dynamically replaced with the release version during the chart build job.
version: 0.0.1
Copy link

Copilot AI Feb 3, 2026

Choose a reason for hiding this comment

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

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.

Copilot uses AI. Check for mistakes.
@emsearcy emsearcy merged commit 223082c into linuxfoundation:main Feb 19, 2026
3 of 4 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.

3 participants