Add semantic YAML diff PR comments via shared workflow#130
Open
weatherhog wants to merge 2 commits into
Open
Conversation
Calls the new giantswarm/github-workflows/yaml-diff reusable workflow on every PR. It posts a semantic YAML diff (via dyff) of changed source files as a sticky PR comment, ignoring key reordering. This is the enabling infrastructure for giantswarm/roadmap#4121 — once the bot proves stable on real PRs, a follow-up will drop the alphabetical key-ordering rule from .yamllint, letting users write conventional Kubernetes ordering (apiVersion, kind, metadata, spec, status). Also bumps the existing get-diff job's dyff_ver from 1.5.4 to 1.7.1 to standardize on the version used by the shared workflow. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
The new Unreleased entries exceeded the 120-char line-length limit enforced by the pre-commit markdownlint hook. Bullets wrapped with 2-space continuation; rendered output is unchanged. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Validation output log |
Rendered manifest diff output log |
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.
Summary
Adopts the new
giantswarm/github-workflows/.github/workflows/yaml-diff.yamlreusable workflow. On every PR, a bot now posts a semantic YAML diff (viadyff) of changed source files as a sticky comment, ignoring key reordering.This is additive infrastructure for giantswarm/roadmap#4121. No existing CI behaviour changes:
key-ordering: {}in.yamllintstays in this PR. yamllint continues to enforce alphabetical key ordering as before.Once the bot has run on real PRs and proves stable (~1–2 weeks), a separate small PR will drop
key-ordering: {}from.yamllint, closing #4121.Changes
.github/workflows/yaml-diff.yaml— thin caller; declares its ownpull-requests: write+contents: readpermissions (a reusable workflow can only narrow, not grant)..github/workflows/validate.yaml— bumpdyff_verfrom1.5.4to1.7.1to match the shared workflow.Dependency
Depends on giantswarm/github-workflows#190 being merged. The caller references
@main, matching the convention used by other gitops-template reusable callers.Test plan
yamllintto still fail (rule still in place) and bot to post "No semantic YAML differences" — proves the bot can detect the no-op even with the rule active./no_diffs_printingin PR body → bot skips posting.get-diffjob still works after thedyff_verbump.🤖 Generated with Claude Code