Skip to content

feat(yaml-diff): colourise diff output via ```diff fenced block #232

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
weatherhog merged 1 commit into from
Jul 2, 2026
Merged

feat(yaml-diff): colourise diff output via ```diff fenced block #232

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions .github/workflows/yaml-diff.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ jobs:
section=$(mktemp)
{
echo
echo "=== ${path} ==="
echo "@@ ${path} @@"
cat /tmp/yaml-diff/file-diff
} > "${section}"

Expand Down Expand Up @@ -227,8 +227,15 @@ jobs:
echo "<summary>Output</summary>"
echo "<!-- mandatory empty line -->"
echo
echo '```'
cat /tmp/yaml-diff/body
echo '```diff'
# GitHub colours a `diff` fence by line prefix: `-` red, `+` green,
# `@@ … @@` header. dyff go-patch prefixes changed values with an
# *indented* `-`/`+`; move the marker to column 0 while keeping the
# original indent *after* it, so the highlighter fires and nesting is
# still visible. The rewrite only reorders leading whitespace, so byte
# counts (and the truncation maths above) are unchanged. dyff colour
# stays off (auto-off in CI) — comments cannot render ANSI.
sed -E 's/^([[:space:]]*)([+-])([[:space:]].*)$/\2\1\3/' /tmp/yaml-diff/body
echo '```'
echo "</details>"
echo "<!-- mandatory empty line -->"
Expand Down
6 changes: 6 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
however this project does not use Semantic Versioning and there are no releases.
Instead this file uses a date-based structure.

## 2026-07-02

### Changed

- `yaml-diff.yaml` now posts its `dyff` output inside a ` ```diff ` fenced block so GitHub colourises it — removed values render red, added values green, and each file gets a `@@ … @@` header. dyff's go-patch `-`/`+` markers are moved to column 0 (indentation preserved after the marker) so the highlighter picks them up; the rewrite only reorders leading whitespace, so the comment-size truncation limits are unaffected. dyff's own ANSI colour stays disabled (comments can't render it). Requested in giantswarm/roadmap#4121.

## 2026-06-30

### Fixed
Expand Down