Support ignore deletions with "ignore_file_deletions" param

Test files_to_ignore code path

Tweak the variable type

Correct bad logic in the file ignore block

Debug

More debugging

More debugging

Fingers crossed

Another try

Last try

Lets see if this one does it

Testing again

More tests

More testing

Last test

Wait, I might be onto something

Put some changes back

Fixes

Whoops

Walk back yml test

Author: johnlk

action.yml

@@ -59,6 +59,10 @@ inputs:
     description: 'Whitespace separated list of files to ignore when calculating the PR size (sum of changes)'
     required: false
     default: ''
+  ignore_file_deletions:
+    description: 'Ignore lines that are deleted, thereby only considering additions.'
+    required: false
+    default: 'false'
 runs:
   using: 'docker'
   image: 'Dockerfile'
@@ -77,6 +81,7 @@ runs:
     - --fail_if_xl=${{ inputs.fail_if_xl }}
     - --message_if_xl="${{ inputs.message_if_xl }}"
     - --files_to_ignore=${{ inputs.files_to_ignore }}
+    - --ignore_file_deletions=${{ inputs.ignore_file_deletions }}
 branding:
   icon: 'tag'
   color: 'green'

src/github.sh

@@ -5,36 +5,49 @@ GITHUB_API_HEADER="Accept: application/vnd.github.v3+json"
 github::calculate_total_modifications() {
   local -r pr_number="${1}"
   local -r files_to_ignore="${2}"
+  local -r ignore_file_deletions="${3}"
+
+  local additions=0
+  local deletions=0
 
   if [ -z "$files_to_ignore" ]; then
     local -r body=$(curl -sSL -H "Authorization: token $GITHUB_TOKEN" -H "$GITHUB_API_HEADER" "$GITHUB_API_URL/repos/$GITHUB_REPOSITORY/pulls/$pr_number")
 
-    local -r additions=$(echo "$body" | jq '.additions')
-    local -r deletions=$(echo "$body" | jq '.deletions')
+    additions=$(echo "$body" | jq '.additions')
 
-    echo $((additions + deletions))
+    if [ "$ignore_file_deletions" != "true" ]; then
+      ((deletions += $(echo "$body" | jq '.deletions')))
+    fi
   else
     local -r body=$(curl -sSL -H "Authorization: token $GITHUB_TOKEN" -H "$GITHUB_API_HEADER" "$GITHUB_API_URL/repos/$GITHUB_REPOSITORY/pulls/$pr_number/files?per_page=100")
 
-    local changes=0
-
     for file in $(echo "$body" | jq -r '.[] | @base64'); do
-      local ignore_file=0
-      for file_to_ignore in $files_to_ignore; do
-        if [ -z "$file_to_ignore" ]; then
-          continue
-        fi
-        if [[ "$(jq::base64 '.filename')" == $file_to_ignore ]]; then
-          ignore_file=1
+      _jq() {
+        echo ${file} | base64 -d | jq -r ${1}
+      }
+
+      filename=$(_jq '.filename')
+      ignore=false
+
+      for pattern in $files_to_ignore; do
+
+        if [[ $filename == $pattern ]]; then
+          ignore=true
+          break
         fi
       done
-      if [ $ignore_file -eq 0 ]; then
-        ((changes += $(jq::base64 '.changes')))
+
+      if [ "$ignore" = false ]; then
+        ((additions += $(_jq '.additions')))
+
+        if [ "$ignore_file_deletions" != "true" ]; then
+          ((deletions += $(_jq '.deletions')))
+        fi
       fi
     done
-
-    echo $changes
   fi
+
+  echo $((additions + deletions))
 }
 
 github::add_label_to_pr() {

src/github_actions.sh

@@ -1,5 +1,12 @@
 #!/usr/bin/env bash
 
 github_actions::get_pr_number() {
-  jq --raw-output .pull_request.number "$GITHUB_EVENT_PATH"
+  local -r pull_request_number=$(jq --raw-output .pull_request.number "$GITHUB_EVENT_PATH")
+
+  if [[ "$pull_request_number" != "null" ]]; then
+    echo "$pull_request_number"
+  else
+    echo "Not a pull request event"
+    exit 1
+  fi
 }

src/labeler.sh

@@ -9,9 +9,10 @@ labeler::label() {
   local -r fail_if_xl="${10}"
   local -r message_if_xl="${11}"
   local -r files_to_ignore="${12}"
+  local -r ignore_file_deletions="${13}"
 
   local -r pr_number=$(github_actions::get_pr_number)
-  local -r total_modifications=$(github::calculate_total_modifications "$pr_number" "$files_to_ignore")
+  local -r total_modifications=$(github::calculate_total_modifications "$pr_number" "${files_to_ignore[*]}" "$ignore_file_deletions")
 
   log::message "Total modifications (additions + deletions): $total_modifications"
   log::message "Ignoring files (if present): $files_to_ignore"

src/main.sh

@@ -9,7 +9,7 @@ source "$PR_SIZE_LABELER_HOME/src/misc.sh"
 ##? Adds a size label to a GitHub Pull Request
 ##?
 ##? Usage:
-##?   main.sh --github_token=<token> --xs_label=<label> --xs_max_size=<size> --s_label=<label> --s_max_size=<size> --m_label=<label> --m_max_size=<size> --l_label=<label> --l_max_size=<size> --xl_label=<label> --fail_if_xl=<false> --message_if_xl=<message> --github_api_url=<url> --files_to_ignore=<files>
+##?   main.sh --github_token=<token> --xs_label=<label> --xs_max_size=<size> --s_label=<label> --s_max_size=<size> --m_label=<label> --m_max_size=<size> --l_label=<label> --l_max_size=<size> --xl_label=<label> --fail_if_xl=<false> --message_if_xl=<message> --github_api_url=<url> --files_to_ignore=<files> --ignore_file_deletions=<false>
 main() {
   eval "$(/root/bin/docpars -h "$(grep "^##?" "$PR_SIZE_LABELER_HOME/src/main.sh" | cut -c 5-)" : "$@")"
 
@@ -31,7 +31,8 @@ main() {
     "$xl_label" \
     "$fail_if_xl" \
     "$message_if_xl" \
-    "$files_to_ignore"
+    "$files_to_ignore" \
+    "$ignore_file_deletions"
 
   exit $?
 }

tests/github_test.sh

@@ -8,7 +8,8 @@ function set_up() {
 function test_should_ignore_files_with_glob() {
   local -r pr_number=123
   local -r files_to_ignore=("*.lock" ".editorconfig")
+
   mock curl cat ./tests/fixtures/test_should_ignore_files_with_regex_response
 
-  assert_match_snapshot "$(github::calculate_total_modifications "$pr_number" "${files_to_ignore[*]}")"
+  assert_match_snapshot "$(github::calculate_total_modifications "$pr_number" "${files_to_ignore[*]}" "false")"
 }