Skip to content

fix: report tech-debt changes by data-row content, not line count #45

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

Open
kim-em wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix: report tech-debt changes by data-row content, not line count #45

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
49 changes: 33 additions & 16 deletions scripts/reporting/technical-debt-metrics.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,27 +187,44 @@ if [[ "${level}" == "weak" ]]; then
fi
}

# Filter `report`'s output down to just the data rows whose Change column is
# a non-zero integer, dropping the table headers, any blank/footer lines, and
# everything inside fenced ``` blocks (the Deprecated-files spoiler). A "data
# row" from `computeDiff` is `|N|diff|name|`; `N` may be empty if a counter
# disappeared in the new commit, so we test the Change column rather than the
# Current column.
filterChangedRows () {
awk -F'|' '
BEGIN { inFence = 0 }
/^```/ { inFence = !inFence; next }
(!inFence) && ($3+0 == $3) && ($3+0 != 0) { print }
'
}

prSummaryReport () {
level="${1}"
rep="${2}"
changedRows="${2}"

if [ "$(wc -l <<<"${rep}")" -le 5 ]
if [ -z "${changedRows}" ]
then
printf '<details><summary>No changes to %s technical debt.</summary>\n' "${level}"
return 1
else
printf '%s\n' "${rep}" | # outputs lines containing `|Current number|Change|Type|`, so
# `$2` refers to `Current number` and `$3` to `Change`.
awk -F '|' -v rep="${rep}" '
BEGIN{total=0; weight=0; absWeight=0}
{absWeight+=$3+0}
(($3+0 == $3) && (!($2+0 == 0))) {total+=1 / $2; weight+=$3 / $2}
END{
if (total == 0) {average=absWeight} else {average=weight/total}
if(average < 0) {change= "Decrease"; average=-average; weight=-weight} else {change= "Increase"}
printf("<details><summary>%s in '"${level}"' tech debt: (relative, absolute) = (%4.2f, %4.2f)</summary>\n\n%s\n", change, average, weight, rep) }'
return 0
fi

# Reconstruct the rendered table with the header rows that the awk filter dropped.
rep="$(printf '|Current number|Change|Type|\n|-:|:-:|:-|\n%s\n' "${changedRows}")"

printf '%s\n' "${rep}" | # outputs lines containing `|Current number|Change|Type|`, so
# `$2` refers to `Current number` and `$3` to `Change`.
awk -F '|' -v rep="${rep}" '
BEGIN{total=0; weight=0; absWeight=0}
{absWeight+=$3+0}
(($3+0 == $3) && (!($2+0 == 0))) {total+=1 / $2; weight+=$3 / $2}
END{
if (total == 0) {average=absWeight} else {average=weight/total}
if(average < 0) {change= "Decrease"; average=-average; weight=-weight} else {change= "Increase"}
printf("<details><summary>%s in '"${level}"' tech debt: (relative, absolute) = (%4.2f, %4.2f)</summary>\n\n%s\n", change, average, weight, rep) }'
return 0
}

# What to print at the end of a set of reports.
Expand All @@ -221,8 +238,8 @@ if [ "${1:-}" == "pr_summary" ]
then
alreadyPrintedFooter="false"

repStrong="$(report strong | awk -F'|' 'BEGIN{backTicks=0} /^```/{backTicks++} ((!/^```/) && (backTicks % 2 == 0) && !($3 == "0")) {print $0}')"
repWeak="$(report weak | awk -F'|' 'BEGIN{backTicks=0} /^```/{backTicks++} ((!/^```/) && (backTicks % 2 == 0) && !($3 == "0")) {print $0}')"
repStrong="$(report strong | filterChangedRows)"
repWeak="$(report weak | filterChangedRows)"
if prSummaryReport strong "${repStrong}"; then
reportFooter
printf '\nThis script lives in the [`mathlib-ci`](https://github.com/leanprover-community/mathlib-ci) repository. To run it locally, from your `mathlib4` directory:\n```\ngit clone https://github.com/leanprover-community/mathlib-ci.git ../mathlib-ci\n../mathlib-ci/scripts/reporting/technical-debt-metrics.sh pr_summary\n```\n%s\n</details>\n' '* The `relative` value is the weighted *sum* of the differences with weight given by the *inverse* of the current value of the statistic.
Expand Down