diff --git a/action.yml b/action.yml index 867f1bb..57a7048 100644 --- a/action.yml +++ b/action.yml @@ -81,7 +81,7 @@ runs: prs=$(curl -X 'GET' \ "$GITHUB_API_URL/repos/$GITHUB_REPOSITORY/pulls?state=open&sort=recentupdate" \ -H "Authorization: token $GITHUB_TOKEN" \ - -H 'accept: application/json') + -H 'Accept: application/json') pr_number=$(echo "$prs" | jq --arg head_ref "$head_ref" '.[] | select(.head.ref == $head_ref) | .number') diff --git a/comment_on_pr.sh b/comment_on_pr.sh index e7a7487..a5446e8 100755 --- a/comment_on_pr.sh +++ b/comment_on_pr.sh @@ -39,31 +39,40 @@ has_elements() { # If BASE_REPORT is provided, a comparison will be made markdown_from_report() { cat <<-"EOF" - + - # Flake output sizes +# 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). +- `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" - - `[NAR] Size Change`: the amount changed compared to the main branch. +- `[NAR] Size Change`: the amount changed compared to the main branch. + +
+ EOF + else + cat <<-"EOF" + EOF 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. +- For Packages you care about both the `Size` and the `NAR Size`. + - 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. + +
- - For NixOS configurations you generally care only about the `Size` (closure size/size on disk). - - Reduce the `Size` by disabling unneeded services/default packages. - - For Packages you care about both the `Size` and the `NAR Size`. - - 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 @@ -140,15 +149,15 @@ if [ -z "$COMMENT_ID" ]; then log 'Posting new comment' curl -o - -X 'POST' \ "$GITHUB_API_URL/repos/$GITHUB_REPOSITORY/issues/$PR_ID/comments" \ - -H 'accept: application/json' \ + -H 'Accept: application/json' \ -H "Authorization: token $GITHUB_TOKEN" \ -H 'Content-Type: application/json' \ -d "$data" else log "Editing comment $COMMENT_ID" curl -o - -X 'PATCH' \ - "$GITHUB_API_URL/repos/$GITHUB_REPOSITORY/issues/$PR_ID/comments/$COMMENT_ID" \ - -H 'accept: application/json' \ + "$GITHUB_API_URL/repos/$GITHUB_REPOSITORY/issues/comments/$COMMENT_ID" \ + -H 'Accept: application/json' \ -H "Authorization: token $GITHUB_TOKEN" \ -H 'Content-Type: application/json' \ -d "$data" diff --git a/retrieve-old-report.sh b/retrieve-old-report.sh index e7c8de6..14a48db 100755 --- a/retrieve-old-report.sh +++ b/retrieve-old-report.sh @@ -5,7 +5,7 @@ repo_info() { curl -X GET \ -H "Authorization: token $GITHUB_TOKEN" \ - -H 'accept: application/json' \ + -H 'Accept: application/json' \ "$GITHUB_API_URL/repos/$GITHUB_REPOSITORY" } @@ -22,7 +22,7 @@ base_report_url() { curl -X 'GET' \ "$GITHUB_API_URL/repos/$GITHUB_REPOSITORY/actions/tasks" \ -H "Authorization: token $GITHUB_TOKEN" \ - -H 'accept: application/json' | + -H 'Accept: application/json' | jq --raw-output \ --arg name "$JOB_NAME" \ --arg head_branch "$1" \