Add AI-friendly output format for LLM integration#920
Open
Add AI-friendly output format for LLM integration#920
Conversation
Implement a new 'ai' output format that produces structured JSON with complete diff information, making it easy for Large Language Models to parse and analyze Helm chart changes. The new format includes: - Resource metadata (api, kind, namespace, name, change type) - Full diff content with each line categorized (added/removed/common) - Properly escaped JSON output for reliable parsing Usage: helm diff upgrade --output ai release-name chart-name Resolves #919 Signed-off-by: yxx <yxx@example.com>
- Replace manual JSON string concatenation with structured Go types and json.Encoder - Restructure output to be more AI-friendly with separate metadata, summary, and content sections - Categorize changes into added/removed/modified arrays for clearer diff presentation - Add human-readable summary field (e.g., "Modified: +1, -1") for quick overview - Remove manual escape functions in favor of automatic JSON encoding - Add comprehensive unit tests covering multiple scenarios - Update existing tests to match new output format The new format provides: - Structured metadata for resource identification - Clear categorization of changes without noise from "common" lines - Summary field for quick understanding of change impact - Better maintainability through type safety and automatic JSON handling Signed-off-by: yxxhero <aiopsclub@163.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Implement a new 'ai' output format that produces structured JSON with complete diff information, making it easy for Large Language Models to parse and analyze Helm chart changes.
The new format includes:
Usage:
helm diff upgrade --output ai release-name chart-name
Resolves #919