feat: add yaml-diff reusable workflow - #190
Merged
Merged
Conversation
Posts a semantic YAML diff (via dyff) of source files changed in a PR as a sticky PR comment. Key reordering without value changes is ignored, so reviewers see only meaningful changes. Companion to helm-render-diff.yaml (which diffs rendered Helm output rather than source). Shares the `/no_diffs_printing` opt-out with helm-render-diff.yaml — one command, one UX. Per-file and total comment size caps (5k / 60k chars) prevent silent failures at GitHub's 65536-char comment limit. SOPS-encrypted files (`*.enc.yaml`) and `.github/**` excluded by default. Enables consumers to drop alphabetical-key-ordering enforcement from their yamllint configs without losing diff readability. See giantswarm/roadmap#4121. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
5 tasks
The exclude_paths description exceeded the 200-char line-length limit. Folded into a multi-line block scalar (>-); rendered string is identical. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
# Conflicts: # CHANGELOG.md
ljakimczuk
approved these changes
Jun 25, 2026
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
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.
Summary
Adds a new reusable workflow
yaml-diff.yamlthat posts a semantic YAML diff (viadyff) of source files changed in a PR as a sticky PR comment. Key reordering without value changes is ignored, so reviewers see only meaningful changes.Companion to
helm-render-diff.yaml(which diffs rendered Helm output, not source).Together these enable consumers — starting with
giantswarm/gitops-template— to drop alphabetical-key-ordering enforcement from their yamllint configs without losing diff readability. See giantswarm/roadmap#4121.Design notes
helm-render-diff.yaml:check-cmp-stateopt-out job +find-comment → delete → create-or-updatetrio./no_diffs_printing: one command silences both bots.**/*.enc.yaml(SOPS),.github/**,.pre-commit-config.yaml— mirrors theignore:block ingitops-template/.yamllint.pull-requests: readon the opt-out check job,contents: read+pull-requests: writeonly on the diff job.Inputs
dyff_version1.7.1paths*.yaml *.ymlexclude_paths**/*.enc.yaml .github/** .pre-commit-config.yamlTest plan
giantswarm/gitops-templatevia companion PR (separate)/no_diffs_printingin PR body or comment → bot skips*.enc.yaml→ excludedFollow-up
Once this workflow has been running in
gitops-templatefor ~1–2 weeks on real PRs, a separate small PR will dropkey-ordering: {}fromgitops-template/.yamllint, closing #4121.🤖 Generated with Claude Code