Skip to content

Commit b3355a1

Browse files
committed
Adopt boilerplate terminology in service automation
Use canonical boilerplate report fields and generated copy while retaining legacy service-manifest compatibility.
1 parent 889493b commit b3355a1

5 files changed

Lines changed: 333 additions & 185 deletions

File tree

.github/workflows/service-update-report.yml

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ on:
1313
required: false
1414
default: ""
1515
type: string
16-
build_template_mode:
17-
description: Include report-only build-template checks
16+
build_boilerplate_mode:
17+
description: Include report-only build-boilerplate checks
1818
required: false
1919
default: report
2020
type: choice
@@ -229,7 +229,7 @@ jobs:
229229
--readme README.md \
230230
--owner wodby \
231231
--repo-filter "^${SERVICE_REPO}$" \
232-
--build-template-mode "${{ inputs.build_template_mode || 'report' }}" \
232+
--build-boilerplate-mode "${{ inputs.build_boilerplate_mode || 'report' }}" \
233233
--output-dir "$REPORT_DIR"
234234
235235
- name: Determine Apply Scope
@@ -321,10 +321,10 @@ jobs:
321321
print("- Status: update candidate")
322322
elif details and details.get("dry_run_diffs"):
323323
print("- Status: manual review dry-run candidate")
324-
elif details and details.get("build_template_review_items"):
325-
print("- Status: build-template review candidate")
326-
elif details and details.get("build_template_warnings"):
327-
print("- Status: build-template warning")
324+
elif details and details.get("build_boilerplate_review_items"):
325+
print("- Status: build-boilerplate review candidate")
326+
elif details and details.get("build_boilerplate_warnings"):
327+
print("- Status: build-boilerplate warning")
328328
elif details and details.get("notifications"):
329329
print("- Status: manual review notification")
330330
elif details and (
@@ -372,20 +372,20 @@ jobs:
372372
print("")
373373
374374
if details and (
375-
details.get("build_template_review_items")
376-
or details.get("build_template_warnings")
375+
details.get("build_boilerplate_review_items")
376+
or details.get("build_boilerplate_warnings")
377377
):
378-
print("### Build Template Review")
379-
print("These checks are report only. The workflow does not apply build template changes.")
378+
print("### Build Boilerplate Review")
379+
print("These checks are report only. The workflow does not apply build boilerplate changes.")
380380
print("")
381-
if details.get("build_template_review_items"):
381+
if details.get("build_boilerplate_review_items"):
382382
print("#### Review Items")
383-
for message in details["build_template_review_items"]:
383+
for message in details["build_boilerplate_review_items"]:
384384
print(f"- {message}")
385385
print("")
386-
if details.get("build_template_warnings"):
386+
if details.get("build_boilerplate_warnings"):
387387
print("#### Warnings")
388-
for message in details["build_template_warnings"]:
388+
for message in details["build_boilerplate_warnings"]:
389389
print(f"- {message}")
390390
print("")
391391
apply_result = (details or {}).get("apply_result") or {}
@@ -462,8 +462,8 @@ jobs:
462462
and details.get("comparable")
463463
and not report["updates"]
464464
and not details["warnings"]
465-
and not details.get("build_template_review_items")
466-
and not details.get("build_template_warnings")
465+
and not details.get("build_boilerplate_review_items")
466+
and not details.get("build_boilerplate_warnings")
467467
and repo not in report["missing_service_yml"]
468468
):
469469
print("No update candidates were found.")
@@ -534,7 +534,7 @@ jobs:
534534
--readme README.md \
535535
--owner wodby \
536536
--repo-filter "^${SERVICE_REPO}$" \
537-
--build-template-mode "${{ inputs.build_template_mode || 'report' }}" \
537+
--build-boilerplate-mode "${{ inputs.build_boilerplate_mode || 'report' }}" \
538538
--output-dir "$REPORT_DIR"
539539
540540
- name: Determine Apply Scope
@@ -626,10 +626,10 @@ jobs:
626626
print("- Status: update candidate")
627627
elif details and details.get("dry_run_diffs"):
628628
print("- Status: manual review dry-run candidate")
629-
elif details and details.get("build_template_review_items"):
630-
print("- Status: build-template review candidate")
631-
elif details and details.get("build_template_warnings"):
632-
print("- Status: build-template warning")
629+
elif details and details.get("build_boilerplate_review_items"):
630+
print("- Status: build-boilerplate review candidate")
631+
elif details and details.get("build_boilerplate_warnings"):
632+
print("- Status: build-boilerplate warning")
633633
elif details and details.get("notifications"):
634634
print("- Status: manual review notification")
635635
elif details and (
@@ -677,20 +677,20 @@ jobs:
677677
print("")
678678
679679
if details and (
680-
details.get("build_template_review_items")
681-
or details.get("build_template_warnings")
680+
details.get("build_boilerplate_review_items")
681+
or details.get("build_boilerplate_warnings")
682682
):
683-
print("### Build Template Review")
684-
print("These checks are report only. The workflow does not apply build template changes.")
683+
print("### Build Boilerplate Review")
684+
print("These checks are report only. The workflow does not apply build boilerplate changes.")
685685
print("")
686-
if details.get("build_template_review_items"):
686+
if details.get("build_boilerplate_review_items"):
687687
print("#### Review Items")
688-
for message in details["build_template_review_items"]:
688+
for message in details["build_boilerplate_review_items"]:
689689
print(f"- {message}")
690690
print("")
691-
if details.get("build_template_warnings"):
691+
if details.get("build_boilerplate_warnings"):
692692
print("#### Warnings")
693-
for message in details["build_template_warnings"]:
693+
for message in details["build_boilerplate_warnings"]:
694694
print(f"- {message}")
695695
print("")
696696
apply_result = (details or {}).get("apply_result") or {}
@@ -767,8 +767,8 @@ jobs:
767767
and details.get("comparable")
768768
and not report["updates"]
769769
and not details["warnings"]
770-
and not details.get("build_template_review_items")
771-
and not details.get("build_template_warnings")
770+
and not details.get("build_boilerplate_review_items")
771+
and not details.get("build_boilerplate_warnings")
772772
and repo not in report["missing_service_yml"]
773773
):
774774
print("No update candidates were found.")

scripts/service_report_email.py

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -98,8 +98,8 @@ def event_counts(
9898
"release_blockers": sum(
9999
1 for item in items if (item.get("planned_release") or {}).get("status") == "blocked"
100100
),
101-
"build_template_review_items": sum(1 for item in items if item.get("build_template_review_items")),
102-
"build_template_warnings": sum(1 for item in items if item.get("build_template_warnings")),
101+
"build_boilerplate_review_items": sum(1 for item in items if item.get("build_boilerplate_review_items")),
102+
"build_boilerplate_warnings": sum(1 for item in items if item.get("build_boilerplate_warnings")),
103103
"applied_updates": sum(
104104
1
105105
for item in items
@@ -211,22 +211,22 @@ def append_repo_dry_run_changes(lines: list[str], items: list[dict[str, Any]]) -
211211
lines.append("")
212212

213213

214-
def append_repo_build_template_review(lines: list[str], items: list[dict[str, Any]]) -> None:
214+
def append_repo_build_boilerplate_review(lines: list[str], items: list[dict[str, Any]]) -> None:
215215
selected = [
216216
(
217217
item,
218-
item.get("build_template_review_items") or [],
219-
item.get("build_template_warnings") or [],
218+
item.get("build_boilerplate_review_items") or [],
219+
item.get("build_boilerplate_warnings") or [],
220220
)
221221
for item in items
222-
if item.get("build_template_review_items") or item.get("build_template_warnings")
222+
if item.get("build_boilerplate_review_items") or item.get("build_boilerplate_warnings")
223223
]
224224
if not selected:
225225
return
226226

227-
lines.append("Build Template Review")
227+
lines.append("Build Boilerplate Review")
228228
lines.append("")
229-
lines.append("These checks are report only. The workflow does not apply build template changes.")
229+
lines.append("These checks are report only. The workflow does not apply build boilerplate changes.")
230230
lines.append("")
231231
for item, updates, warnings in selected:
232232
lines.append(f"{item['repo']}:")
@@ -306,7 +306,7 @@ def build_body(
306306

307307
append_repo_planned_changes(lines, items)
308308
append_repo_dry_run_changes(lines, items)
309-
append_repo_build_template_review(lines, items)
309+
append_repo_build_boilerplate_review(lines, items)
310310
append_repo_apply_results(lines, items)
311311
append_repo_messages(lines, "Updates Without Local Manifest Diff", items, "updates_without_local_diff")
312312
append_grouped_notifications(lines, items)
@@ -536,24 +536,24 @@ def html_dry_run_changes(items: list[dict[str, Any]]) -> str:
536536
return "".join(blocks)
537537

538538

539-
def html_build_template_review(items: list[dict[str, Any]]) -> str:
539+
def html_build_boilerplate_review(items: list[dict[str, Any]]) -> str:
540540
selected = [
541541
(
542542
item,
543-
item.get("build_template_review_items") or [],
544-
item.get("build_template_warnings") or [],
543+
item.get("build_boilerplate_review_items") or [],
544+
item.get("build_boilerplate_warnings") or [],
545545
)
546546
for item in items
547-
if item.get("build_template_review_items") or item.get("build_template_warnings")
547+
if item.get("build_boilerplate_review_items") or item.get("build_boilerplate_warnings")
548548
]
549549
if not selected:
550550
return ""
551551

552552
blocks = [
553553
"<h2 style=\"margin:28px 0 12px 0;font-size:20px;color:#111827;\">"
554-
"Build Template Review</h2>",
554+
"Build Boilerplate Review</h2>",
555555
"<p style=\"margin:0 0 12px 0;color:#4b5563;\">"
556-
"These checks are report only. The workflow does not apply build template changes.</p>",
556+
"These checks are report only. The workflow does not apply build boilerplate changes.</p>",
557557
]
558558
for item, updates, warnings in selected:
559559
blocks.append(
@@ -667,7 +667,7 @@ def build_html_body(
667667
)
668668
body.append(html_planned_changes(items))
669669
body.append(html_dry_run_changes(items))
670-
body.append(html_build_template_review(items))
670+
body.append(html_build_boilerplate_review(items))
671671
body.append(html_apply_results(items))
672672
body.append(html_repo_messages("Updates Without Local Manifest Diff", items, "updates_without_local_diff"))
673673
body.append(html_grouped_notifications(items))
@@ -683,7 +683,7 @@ def build_subject(counts: dict[str, int], workflow_result: str, sha: str) -> str
683683
f"[services] report {status}: "
684684
f"{counts['updates']} update repos, "
685685
f"{counts['dry_run_updates']} dry-run repos, "
686-
f"{counts['build_template_review_items']} build-template repos, "
686+
f"{counts['build_boilerplate_review_items']} build-boilerplate repos, "
687687
f"{counts['major_version_notifications']} major-version repos, "
688688
f"{counts['helm_major_version_notifications']} Helm-major repos ({short_sha})"
689689
)

0 commit comments

Comments
 (0)