diff --git a/comment_on_pr.sh b/comment_on_pr.sh index 69dceeb..99827ed 100755 --- a/comment_on_pr.sh +++ b/comment_on_pr.sh @@ -43,13 +43,11 @@ markdown_from_report() { # Flake output sizes -
Definitions: + **Definitions:** - `Name`: the name of the package/configuration. - `Size`: the closure size (size on disk/NAR size + all transitive dependencies). - `NAR Size`: the size of the build output (package without the dependencies). - -
EOF if [ "${2+set}" = "set" ]; then cat <<-"EOF" @@ -58,7 +56,7 @@ markdown_from_report() { fi cat <<-"EOF" -
Tips on reading this data: + **Tips on reading this data:** - For NixOS configurations you generally care only about the `Size` (closure size/size on disk). - Reduce the `Size` by disabling unneeded services/default packages. @@ -66,8 +64,6 @@ markdown_from_report() { - Reduce the `NAR Size` by reducing the size of the build outputs, e.g. don't copy unnecessary data to the $out dir, optimize binaries for size, etc. - Reduce the `Size` by reducing the dependencies (e.g. `buildInputs`). - Don't worry too much about size, some dependencies are deduplicated, e.g. `glibc` adds ~40MiB to the `Size`, but is generally shared by ~every binary on the system, so, chances are, you are already including it from somewhere else and statically linking with e.g. `musl` is not gonna improve things. - -
EOF if [ "${2+set}" = "set" ]; then