jalil/nix-flake-outputs-size
1
0
Fork 0
Code Issues Pull requests Activity Actions

feat: add nix for formatting
Some checks failed
/ check (treefmt) (push) Successful in 5s
Details
/ check-renovaterc (push) Successful in 2s
Details
/ report-size (push) Failing after 0s
Details

Browse source 
Also adds CI tests!
This commit is contained in:
Jalil David Salamé Messina 2025-03-10 22:58:18 +01:00
parent 58249e9ad0
commit 01fae63422
Signed by: jalil
GPG key ID: F016B9E770737A0B
9 changed files with 314 additions and 121 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
.editorconfig Normal file
View file

@ -0,0 +1,8 @@
[*]
end_of_line = lf
charset = utf-8
[*.{nix,json,sh}]
indent_style = space
indent_size = 2
trim_trailing_whitespace = true

41
.forgejo/workflows/check.yml Normal file
View file

@ -0,0 +1,41 @@
on:
push:
jobs:
check:
runs-on: nixos
strategy:
matrix:
check:
- treefmt
steps:
- uses: "https://git.salame.cl/actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683" # v4
- name: Run checks
run: |
nix --version
# shellcheck disable=SC2016
nix build --print-build-logs '.#checks.x86_64-linux.${{ matrix.check }}'
check-renovaterc:
runs-on: nixos
steps:
- uses: "https://git.salame.cl/actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683" # v4
- name: Validate renovaterc.json
run: |
nix --version
nix shell nixpkgs#renovate --command renovate-config-validator
report-size:
runs-on: nixos
needs: check
steps:
- uses: "https://git.salame.cl/actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683" # v4
- run: nix --version
- name: Create Size Report
uses: ./action.yml
with:
# Create a comment on the associated PR
comment-on-pr: ${{ github.ref_name != 'main' }}
# Generate artifacts on main (to speed up comparisons)
generate-artifact: ${{ github.ref_name == 'main' }}
# Generate comparisons to main
do-comparison: 'true'
# This job's name (so we can find the artifacts)
job-name: report-size

1
README.md
View file

@ -51,6 +51,7 @@ For more details see the [action.yaml](./action.yml) file.
- 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 `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`). - 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. - 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.
# NixOS Configurations # NixOS Configurations
| Name | Size | Size Change | NAR Size | NAR Size Change | | Name | Size | Size Change | NAR Size | NAR Size Change |

116
comment_on_pr.sh
View file

@ -11,34 +11,34 @@ util_path="${GITHUB_ACTION_PATH:-.}/utils.sh"
# #
# JSON_FILE can be piped from stdin # JSON_FILE can be piped from stdin
json_to_md_rows() { json_to_md_rows() {
jq --raw-output \ jq --raw-output \
".$1[]"' | "| `\(.name)` | \(.size) | \(.narSize) |"' "$2" | ".$1[]"' | "| `\(.name)` | \(.size) | \(.narSize) |"' "$2" |
numfmt --suffix=B --to=iec-i --field=4,6 numfmt --suffix=B --to=iec-i --field=4,6
} }
# USAGE: json_to_md_rows <FIELD> [JSON_FILE] # USAGE: json_to_md_rows <FIELD> [JSON_FILE]
# #
# JSON_FILE can be piped from stdin # JSON_FILE can be piped from stdin
json_to_md_rows_and_change() { json_to_md_rows_and_change() {
jq --raw-output \ jq --raw-output \
".$1[]"' | "| `\(.name)` | \(.size) | \(.sizeChange) | \(.narSize) | \(.narSizeChange) |"' | ".$1[]"' | "| `\(.name)` | \(.size) | \(.sizeChange) | \(.narSize) | \(.narSizeChange) |"' |
numfmt --suffix=B --to=iec-i --field=4,6,8,10 numfmt --suffix=B --to=iec-i --field=4,6,8,10
} }
# USAGE: has_elements <FIELD> <JSON_FILE> # USAGE: has_elements <FIELD> <JSON_FILE>
has_elements() { has_elements() {
if [ "${2+set}" = 'set' ]; then if [ "${2+set}" = 'set' ]; then
[ "$(jq ".$1 != []" "$2")" = 'true' ] [ "$(jq ".$1 != []" "$2")" = 'true' ]
else else
[ "$(jq ".$1 != []")" = 'true' ] [ "$(jq ".$1 != []")" = 'true' ]
fi fi
} }
# USAGE: markdown_from_report <REPORT> [BASE_REPORT] # USAGE: markdown_from_report <REPORT> [BASE_REPORT]
# #
# If BASE_REPORT is provided, a comparison will be made # If BASE_REPORT is provided, a comparison will be made
markdown_from_report() { markdown_from_report() {
cat <<-"EOF" cat <<-"EOF"
<!-- AUTOGENERATED by nix-flake-outputs-size action --> <!-- AUTOGENERATED by nix-flake-outputs-size action -->
# Flake output sizes # Flake output sizes
@ -49,12 +49,12 @@ markdown_from_report() {
- `Size`: the closure size (size on disk/NAR size + all transitive dependencies). - `Size`: the closure size (size on disk/NAR size + all transitive dependencies).
- `NAR Size`: the size of the build output (package without the dependencies). - `NAR Size`: the size of the build output (package without the dependencies).
EOF EOF
if [ "${2+set}" = "set" ]; then if [ "${2+set}" = "set" ]; then
cat <<-"EOF" cat <<-"EOF"
- `[NAR] Size Change`: the amount changed compared to the main branch. - `[NAR] Size Change`: the amount changed compared to the main branch.
EOF EOF
fi fi
cat <<-"EOF" cat <<-"EOF"
**Tips on reading this data:** **Tips on reading this data:**
@ -66,62 +66,62 @@ markdown_from_report() {
- 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. - 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 EOF
if [ "${2+set}" = "set" ]; then if [ "${2+set}" = "set" ]; then
compare=$(jq --slurp --from-file "${GITHUB_ACTION_PATH:-.}/compare.jq" "$1" "$2") compare=$(jq --slurp --from-file "${GITHUB_ACTION_PATH:-.}/compare.jq" "$1" "$2")
if echo "$compare" | has_elements 'nixosConfigurations'; then if echo "$compare" | has_elements 'nixosConfigurations'; then
cat <<-"EOF" cat <<-"EOF"
# NixOS Configurations # NixOS Configurations
| Name | Size | Size Change | NAR Size | NAR Size Change | | Name | Size | Size Change | NAR Size | NAR Size Change |
|------|-----:|------------:|---------:|----------------:| |------|-----:|------------:|---------:|----------------:|
EOF EOF
echo "$compare" | json_to_md_rows_and_change "nixosConfigurations" echo "$compare" | json_to_md_rows_and_change "nixosConfigurations"
echo echo
fi fi
if echo "$compare" | has_elements 'packages'; then if echo "$compare" | has_elements 'packages'; then
cat <<-"EOF" cat <<-"EOF"
# Packages # Packages
| Name | Size | Size Change | NAR Size | NAR Size Change | | Name | Size | Size Change | NAR Size | NAR Size Change |
|------|-----:|------------:|---------:|----------------:| |------|-----:|------------:|---------:|----------------:|
EOF EOF
echo "$compare" | json_to_md_rows_and_change "packages" echo "$compare" | json_to_md_rows_and_change "packages"
echo echo
fi fi
else else
if has_elements 'nixosConfigurations' "$1"; then if has_elements 'nixosConfigurations' "$1"; then
cat <<-"EOF" cat <<-"EOF"
# NixOS Configurations # NixOS Configurations
| Name | Size | NAR Size | | Name | Size | NAR Size |
|------|-----:|---------:| |------|-----:|---------:|
EOF EOF
json_to_md_rows "nixosConfigurations" "$1" json_to_md_rows "nixosConfigurations" "$1"
echo echo
fi fi
if has_elements 'packages' "$1"; then if has_elements 'packages' "$1"; then
cat <<-"EOF" cat <<-"EOF"
# Packages # Packages
| Name | Size | NAR Size | | Name | Size | NAR Size |
|------|-----:|---------:| |------|-----:|---------:|
EOF EOF
json_to_md_rows "packages" "$1" json_to_md_rows "packages" "$1"
echo echo
fi fi
fi fi
} }
# Test outside CI # Test outside CI
if [ "${CI:-false}" != 'true' ]; then if [ "${CI:-false}" != 'true' ]; then
markdown_from_report "$@" markdown_from_report "$@"
exit 0 exit 0
fi fi
# Protect against running before a PR is made or if it is triggered on the main branch # Protect against running before a PR is made or if it is triggered on the main branch
if [ -z "$PR_ID" ]; then if [ -z "$PR_ID" ]; then
warn "No PR created for this commit" warn "No PR created for this commit"
exit 0 exit 0
fi fi
log 'Generating comment body' log 'Generating comment body'
@ -137,19 +137,19 @@ log "$data"
endgroup endgroup
if [ -z "$COMMENT_ID" ]; then if [ -z "$COMMENT_ID" ]; then
log 'Posting new comment' log 'Posting new comment'
curl -o - -X 'POST' \ curl -o - -X 'POST' \
"$GITHUB_API_URL/repos/$GITHUB_REPOSITORY/issues/$PR_ID/comments" \ "$GITHUB_API_URL/repos/$GITHUB_REPOSITORY/issues/$PR_ID/comments" \
-H 'accept: application/json' \ -H 'accept: application/json' \
-H "Authorization: token $GITHUB_TOKEN" \ -H "Authorization: token $GITHUB_TOKEN" \
-H 'Content-Type: application/json' \ -H 'Content-Type: application/json' \
-d "$data" -d "$data"
else else
log "Editing comment $COMMENT_ID" log "Editing comment $COMMENT_ID"
curl -o - -X 'PATCH' \ curl -o - -X 'PATCH' \
"$GITHUB_API_URL/repos/$GITHUB_REPOSITORY/issues/$PR_ID/comments/$COMMENT_ID" \ "$GITHUB_API_URL/repos/$GITHUB_REPOSITORY/issues/$PR_ID/comments/$COMMENT_ID" \
-H 'accept: application/json' \ -H 'accept: application/json' \
-H "Authorization: token $GITHUB_TOKEN" \ -H "Authorization: token $GITHUB_TOKEN" \
-H 'Content-Type: application/json' \ -H 'Content-Type: application/json' \
-d "$data" -d "$data"
fi fi

48
create-report.sh
View file

@ -13,7 +13,7 @@ endgroup
group 'Show Packages' group 'Show Packages'
packages=$( packages=$(
jq --raw-output '.packages."x86_64-linux" | select(. != null) | keys[]' <<-EOF jq --raw-output '.packages."x86_64-linux" | select(. != null) | keys[]' <<-EOF
$flake_info $flake_info
EOF EOF
) )
@ -22,7 +22,7 @@ endgroup
group 'Show NixOS Configurations' group 'Show NixOS Configurations'
configurations=$( configurations=$(
jq --raw-output '.nixosConfigurations | select(. != null) | keys[]' <<-EOF jq --raw-output '.nixosConfigurations | select(. != null) | keys[]' <<-EOF
$flake_info $flake_info
EOF EOF
) )
@ -30,34 +30,34 @@ log "$configurations"
endgroup endgroup
pkgs_json() { pkgs_json() {
group 'Building packages' group 'Building packages'
trap endgroup RETURN trap endgroup RETURN
for package in $packages; do for package in $packages; do
log "Building $package" log "Building $package"
path=$(nix build --print-out-paths ".#$package") path=$(nix build --print-out-paths ".#$package")
log "Calculating size of $package" log "Calculating size of $package"
nix path-info --closure-size --json "$path" | nix path-info --closure-size --json "$path" |
jq --compact-output --arg pkg "$package" '.[] | {"name": $pkg, "size": .closureSize, "narSize": .narSize}' jq --compact-output --arg pkg "$package" '.[] | {"name": $pkg, "size": .closureSize, "narSize": .narSize}'
done done
endgroup endgroup
} }
configs_json() { configs_json() {
group 'Building NixOS configurations' group 'Building NixOS configurations'
trap endgroup RETURN trap endgroup RETURN
for config in $configurations; do for config in $configurations; do
log "Building $config" log "Building $config"
path=$(nix build --print-out-paths ".#nixosConfigurations.$config.config.system.build.toplevel") path=$(nix build --print-out-paths ".#nixosConfigurations.$config.config.system.build.toplevel")
log "Calculating size of $config" log "Calculating size of $config"
nix path-info --closure-size --json "$path" | nix path-info --closure-size --json "$path" |
jq --compact-output --arg pkg "$config" '.[] | {"name": $pkg, "size": .closureSize, "narSize": .narSize}' jq --compact-output --arg pkg "$config" '.[] | {"name": $pkg, "size": .closureSize, "narSize": .narSize}'
done done
} }
pkgs=$(pkgs_json | jq --slurp '.') pkgs=$(pkgs_json | jq --slurp '.')
configs=$(configs_json | jq --slurp '.') configs=$(configs_json | jq --slurp '.')
echo "{}" | jq \ echo "{}" | jq \
--argjson pkgs "$pkgs" \ --argjson pkgs "$pkgs" \
--argjson configs "$configs" \ --argjson configs "$configs" \
'{"packages": $pkgs, "nixosConfigurations": $configs}' '{"packages": $pkgs, "nixosConfigurations": $configs}'

98
flake.lock generated Normal file
View file

@ -0,0 +1,98 @@
{
"nodes": {
"flake-parts": {
"inputs": {
"nixpkgs-lib": "nixpkgs-lib"
},
"locked": {
"lastModified": 1741352980,
"narHash": "sha256-+u2UunDA4Cl5Fci3m7S643HzKmIDAe+fiXrLqYsR2fs=",
"owner": "hercules-ci",
"repo": "flake-parts",
"rev": "f4330d22f1c5d2ba72d3d22df5597d123fdb60a9",
"type": "github"
},
"original": {
"owner": "hercules-ci",
"repo": "flake-parts",
"type": "github"
}
},
"nixpkgs": {
"locked": {
"lastModified": 1741513245,
"narHash": "sha256-7rTAMNTY1xoBwz0h7ZMtEcd8LELk9R5TzBPoHuhNSCk=",
"owner": "NixOS",
"repo": "nixpkgs",
"rev": "e3e32b642a31e6714ec1b712de8c91a3352ce7e1",
"type": "github"
},
"original": {
"owner": "NixOS",
"ref": "nixos-unstable",
"repo": "nixpkgs",
"type": "github"
}
},
"nixpkgs-lib": {
"locked": {
"lastModified": 1740877520,
"narHash": "sha256-oiwv/ZK/2FhGxrCkQkB83i7GnWXPPLzoqFHpDD3uYpk=",
"owner": "nix-community",
"repo": "nixpkgs.lib",
"rev": "147dee35aab2193b174e4c0868bd80ead5ce755c",
"type": "github"
},
"original": {
"owner": "nix-community",
"repo": "nixpkgs.lib",
"type": "github"
}
},
"root": {
"inputs": {
"flake-parts": "flake-parts",
"nixpkgs": "nixpkgs",
"systems": "systems",
"treefmt-nix": "treefmt-nix"
}
},
"systems": {
"locked": {
"lastModified": 1681028828,
"narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=",
"owner": "nix-systems",
"repo": "default",
"rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e",
"type": "github"
},
"original": {
"owner": "nix-systems",
"repo": "default",
"type": "github"
}
},
"treefmt-nix": {
"inputs": {
"nixpkgs": [
"nixpkgs"
]
},
"locked": {
"lastModified": 1739829690,
"narHash": "sha256-mL1szCeIsjh6Khn3nH2cYtwO5YXG6gBiTw1A30iGeDU=",
"owner": "numtide",
"repo": "treefmt-nix",
"rev": "3d0579f5cc93436052d94b73925b48973a104204",
"type": "github"
},
"original": {
"owner": "numtide",
"repo": "treefmt-nix",
"type": "github"
}
}
},
"root": "root",
"version": 7
}

43
flake.nix Normal file
View file

@ -0,0 +1,43 @@
{
description = "Description for the project";
inputs = {
flake-parts.url = "github:hercules-ci/flake-parts";
nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
treefmt-nix = {
url = "github:numtide/treefmt-nix";
inputs.nixpkgs.follows = "nixpkgs";
};
systems.url = "github:nix-systems/default";
};
outputs =
inputs@{ flake-parts, ... }:
flake-parts.lib.mkFlake { inherit inputs; } {
imports = [ inputs.treefmt-nix.flakeModule ];
systems = import inputs.systems;
perSystem =
{ pkgs, ... }:
{
# Export pkgs.hello so we can test this action
packages = { inherit (pkgs) hello; };
# Setup formatters
treefmt = {
# Ignore images
settings.global.excludes = [ "*.png" ];
projectRootFile = "flake.nix";
programs = {
mdformat.enable = true;
nixfmt.enable = true;
shfmt.enable = true;
shellcheck.enable = true;
statix.enable = true;
typos.enable = true;
yamlfmt.enable = true;
};
};
};
};
}

68
retrieve-old-report.sh
View file

@ -3,59 +3,59 @@
. "${GITHUB_ACTION_PATH}/utils.sh" . "${GITHUB_ACTION_PATH}/utils.sh"
repo_info() { repo_info() {
curl -X GET \ curl -X GET \
-H "Authorization: token $GITHUB_TOKEN" \ -H "Authorization: token $GITHUB_TOKEN" \
-H 'accept: application/json' \ -H 'accept: application/json' \
"$GITHUB_API_URL/repos/$GITHUB_REPOSITORY" "$GITHUB_API_URL/repos/$GITHUB_REPOSITORY"
} }
in_private_repo() { in_private_repo() {
test "$(repo_info | jq --raw-output '.private')" = 'true' test "$(repo_info | jq --raw-output '.private')" = 'true'
} }
default_branch() { default_branch() {
repo_info | jq --raw-output '.default_branch' repo_info | jq --raw-output '.default_branch'
} }
# USAGE: base_report_url <BASE_BRANCH> # USAGE: base_report_url <BASE_BRANCH>
base_report_url() { base_report_url() {
curl -X 'GET' \ curl -X 'GET' \
"$GITHUB_API_URL/repos/$GITHUB_REPOSITORY/actions/tasks" \ "$GITHUB_API_URL/repos/$GITHUB_REPOSITORY/actions/tasks" \
-H "Authorization: token $GITHUB_TOKEN" \ -H "Authorization: token $GITHUB_TOKEN" \
-H 'accept: application/json' | -H 'accept: application/json' |
jq --raw-output \ jq --raw-output \
--arg name "$JOB_NAME" \ --arg name "$JOB_NAME" \
--arg head_branch "$1" \ --arg head_branch "$1" \
'[.workflow_runs[] | select(.name == $name and .head_branch == $head_branch)] | first | .url' '[.workflow_runs[] | select(.name == $name and .head_branch == $head_branch)] | first | .url'
} }
# USAGE: has_report <REPORT_URL> # USAGE: has_report <REPORT_URL>
has_report() { has_report() {
http_code=$(curl -X 'GET' -o /dev/null --silent -Iw '%{http_code}' \ http_code=$(curl -X 'GET' -o /dev/null --silent -Iw '%{http_code}' \
"$1" -H "Authorization: token $GITHUB_TOKEN") "$1" -H "Authorization: token $GITHUB_TOKEN")
log "Got code $http_code for $1" log "Got code $http_code for $1"
test "$http_code" = '200' test "$http_code" = '200'
} }
# If a base branch is not provided, use the default branch # If a base branch is not provided, use the default branch
base_branch=${BASE_BRANCH:-$(default_branch)} base_branch=${BASE_BRANCH:-$(default_branch)}
if [ "$(in_private_repo)" != 'true' ] && [ "$JOB_NAME" ]; then if [ "$(in_private_repo)" != 'true' ] && [ "$JOB_NAME" ]; then
url=$(base_report_url "$base_branch") url=$(base_report_url "$base_branch")
log "Found previous run at: $url" log "Found previous run at: $url"
report_url="$url/artifacts/$ARTIFACT_NAME" report_url="$url/artifacts/$ARTIFACT_NAME"
if has_report "$report_url"; then if has_report "$report_url"; then
log 'Found previous report, downloading...' log 'Found previous report, downloading...'
curl -X 'GET' \ curl -X 'GET' \
"$report_url" \ "$report_url" \
-H "Authorization: token $GITHUB_TOKEN" | -H "Authorization: token $GITHUB_TOKEN" |
gunzip >old-report.json gunzip >old-report.json
log "Reporting on sizes and comparing to sizes in $base_branch" log "Reporting on sizes and comparing to sizes in $base_branch"
exit 0 exit 0
fi fi
error "Failed to find previous report, expected at: $report_url" error "Failed to find previous report, expected at: $report_url"
fi fi
warn "Couldn't retrieve old report:" warn "Couldn't retrieve old report:"
@ -69,9 +69,9 @@ error "Falling back to slow method (checkout $base_branch and generate the repor
old=$(mktemp -d) old=$(mktemp -d)
group "Download files from $base_branch" group "Download files from $base_branch"
curl -X 'GET' \ curl -X 'GET' \
"$GITHUB_API_URL/repos/$GITHUB_REPOSITORY/archive/$base_branch.tar.gz" \ "$GITHUB_API_URL/repos/$GITHUB_REPOSITORY/archive/$base_branch.tar.gz" \
-H "Authorization: token $GITHUB_TOKEN" | -H "Authorization: token $GITHUB_TOKEN" |
tar -zvx --strip-components=1 -C "$old" tar -zvx --strip-components=1 -C "$old"
endgroup endgroup
(cd "$old" && "$GITHUB_ACTION_PATH/create-report.sh") >old-report.json (cd "$old" && "$GITHUB_ACTION_PATH/create-report.sh") >old-report.json

12
utils.sh
View file

@ -1,19 +1,21 @@
#!/bin/sh
log() { log() {
echo "$@" >&2 echo "$@" >&2
} }
warn() { warn() {
log "\e[0;33m[ERROR]:" "$@" "\e[0m" log "\e[0;33m[ERROR]:" "$@" "\e[0m"
} }
error() { error() {
log "\e[0;31m[WARN]:" "$@" "\e[0m" log "\e[0;31m[WARN]:" "$@" "\e[0m"
} }
group() { group() {
log "::group::$1" log "::group::$1"
} }
endgroup() { endgroup() {
log '::endgroup::' log '::endgroup::'
} }