Skip to content

Improve template-dyff #606

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
benbz merged 3 commits into from
Jul 7, 2025
Merged

Improve template-dyff #606

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f637a0b
CI: just list manifests in that dyff that are added/deleted rather th…
benbz Jul 7, 2025
6c74101
CI: highlight when whole files are added/delete in dyff
benbz Jul 7, 2025
46997a8
CI: don't invent values files to compare if we have one values filena…
benbz Jul 7, 2025
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
62 changes: 33 additions & 29 deletions .github/workflows/templates-dyff.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,8 +89,17 @@ jobs:
continue
fi

templates_files=$(find "$RUNNER_TEMP/old" "$RUNNER_TEMP/new" -maxdepth 2 -name '*.yaml' | grep "$values_dir" | sed -E 's|'"$RUNNER_TEMP"'/(old\|new)/||' | sort | uniq)
templates_files=$(find "$RUNNER_TEMP/old" "$RUNNER_TEMP/new" -maxdepth 2 -name '*.yaml' | grep "/$values_dir/" | sed -E 's|'"$RUNNER_TEMP"'/(old\|new)/||' | sort | uniq)
comment_templates_body=""
values_file_suffix=""
on_both_branches="true"
if [ ! -d "$RUNNER_TEMP/old/$values_dir" ]; then
values_file_suffix=" (added)"
on_both_branches="false"
elif [ ! -d "$RUNNER_TEMP/new/$values_dir" ]; then
values_file_suffix=" (removed)"
on_both_branches="false"
fi

while read -r templates_file; do
current_file="$(basename "$templates_file")"
Expand All @@ -99,40 +108,34 @@ jobs:
fi

if [ ! -f "$RUNNER_TEMP/old/$templates_file" ]; then
api_version=$(yq '.apiVersion' "$RUNNER_TEMP/new/$templates_file")
kind=$(yq '.kind' "$RUNNER_TEMP/new/$templates_file")
name=$(yq '.metadata.name' "$RUNNER_TEMP/new/$templates_file")
namespace=$(yq '.metadata.namespace' "$RUNNER_TEMP/new/$templates_file")
metadata=$(yq '.metadata' "$RUNNER_TEMP/new/$templates_file")
comment_templates_body+="@@ $current_file @@\n"
comment_templates_body+="# $api_version/$kind/$namespace/$name\n"
comment_templates_body+="! + one file added - the full content of the file is available in ${ARTIFACT_URL}\n"
comment_templates_body+="+ apiVersion: $api_version\n"
comment_templates_body+="+ kind: $kind\n"
comment_templates_body+="+ metadata:\n"
while IFS= read -r line; do
comment_templates_body+="+ $line\n"
done <<< "$metadata"
comment_templates_body+="\n\n"
if [ "$on_both_branches" == "true" ]; then
comment_templates_body+="@@ $kind/$namespace/$name @@\n"
while IFS= read -r line; do
comment_templates_body+="+ $line\n"
done < "$RUNNER_TEMP/new/$templates_file"
comment_templates_body+="\n\n"
else
comment_templates_body+="$kind/$namespace/$name added\n"
fi
continue
fi

if [ ! -f "$RUNNER_TEMP/new/$templates_file" ]; then
api_version=$(yq '.apiVersion' "$RUNNER_TEMP/old/$templates_file" )
kind=$(yq '.kind' "$RUNNER_TEMP/old/$templates_file")
name=$(yq '.metadata.name' "$RUNNER_TEMP/old/$templates_file")
namespace=$(yq '.metadata.namespace' "$RUNNER_TEMP/old/$templates_file")
metadata=$(yq '.metadata' "$RUNNER_TEMP/old/$templates_file")
comment_templates_body+="@@ $current_file @@\n"
comment_templates_body+="# $api_version/$kind/$namespace/$name\n"
comment_templates_body+="! - one file removed\n"
comment_templates_body+="- apiVersion: $api_version\n"
comment_templates_body+="- kind: $kind\n"
comment_templates_body+="- metadata:\n"
while IFS= read -r line; do
comment_templates_body+="- $line\n"
done <<< "$metadata"
comment_templates_body+="\n\n"
if [ "$on_both_branches" == "true" ]; then
comment_templates_body+="@@ $kind/$namespace/$name @@\n"
while IFS= read -r line; do
comment_templates_body+="- $line\n"
done < "$RUNNER_TEMP/old/$templates_file"
comment_templates_body+="\n\n"
else
comment_templates_body+="$kind/$namespace/$name removed\n"
fi
continue
fi

Expand All @@ -144,18 +147,16 @@ jobs:
exit 1
fi

api_version=$(yq '.apiVersion' "$RUNNER_TEMP/new/$templates_file")
kind=$(yq '.kind' "$RUNNER_TEMP/new/$templates_file")
name=$(yq '.metadata.name' "$RUNNER_TEMP/new/$templates_file")
namespace=$(yq '.metadata.namespace' "$RUNNER_TEMP/new/$templates_file")
resource_metadata="# $api_version/$kind/$namespace/$name"
comment_templates_body+=$(sed -e "1d" -e "/^@@/a$resource_metadata" <<< "$dyff_detail")
comment_templates_body+=$(sed -e '/^!/d' -e "s|^@@\(.*\)@@|@@ $kind/$namespace/$name -\1@@|" <<< "$dyff_detail")
comment_templates_body+="\n\n\n"
fi
done <<< "$templates_files"

if [[ -n "$comment_templates_body" ]]; then
comment_body+="<details><summary><b>$values_dir.yaml</b></summary>\n"
comment_body+="<details><summary><b>$values_dir.yaml$values_file_suffix</b></summary>\n"
comment_body+='\n```diff\n'
comment_body+="$comment_templates_body"
comment_body+='```\n'
Expand All @@ -166,8 +167,11 @@ jobs:

if [ -z "$comment_body" ]; then
comment_body="No changes in rendered templates"
else
header+="Full contents of manifests and dyffs are available in ${ARTIFACT_URL}\n\n"
fi


echo -e "$header$comment_body" | tee "$RUNNER_TEMP/dyff-output.md"
echo "pr-number=$PR_NUMBER" | tee "$RUNNER_TEMP/pr-number.txt"

Expand Down
1 change: 1 addition & 0 deletions newsfragments/606.internal.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
CI: just list manifests in that dyff that are added/deleted rather than any metadata about them.
Loading
⚡