From 4d260886036edfc074967186d133dcef8b881b47 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Gast=C3=B3n=20Fournier?= <gaston@getunleash.ai>
Date: Fri, 17 Feb 2023 11:12:46 +0100
Subject: [PATCH] chore: comment outcome of null check action (#3133)

## About the change
Post a comment in the Pull Request rather than echo in the console in
case of an error. Also, [reduced the null check errors by
26](https://github.com/Unleash/unleash/actions/runs/4196924954/jobs/7278564622#step:5:40)
---
 .../workflows/gradual-strict-null-checks.yml   | 18 ++++++++++++++----
 src/lib/util/parseEnvVar.ts                    |  2 +-
 2 files changed, 15 insertions(+), 5 deletions(-)

diff --git a/.github/workflows/gradual-strict-null-checks.yml b/.github/workflows/gradual-strict-null-checks.yml
index 407393cce70..0a98afe48b6 100644
--- a/.github/workflows/gradual-strict-null-checks.yml
+++ b/.github/workflows/gradual-strict-null-checks.yml
@@ -10,6 +10,8 @@ concurrency:
 jobs:
   build:
     runs-on: ubuntu-latest
+    env:
+      MAIN_BRANCH: main
 
     strategy:
       matrix:
@@ -23,7 +25,7 @@ jobs:
       - name: Checkout main branch
         uses: actions/checkout@v3
         with:
-          ref: main
+          ref: ${{ env.MAIN_BRANCH }}
           path: main
       - name: Use Node.js ${{ matrix.node-version }}
         uses: actions/setup-node@v3
@@ -33,10 +35,18 @@ jobs:
           cache-dependency-path: |
             current/yarn.lock
             main/yarn.lock
-      # intentionally use the same script from current branch against both repositories
       - name: Compare errors if enabling strictNullChecks
+        env:
+          URL: ${{ github.event.pull_request.comments_url }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
-          set -x
+          comment () {
+            curl -X POST $URL \
+              -H "Content-Type: application/json" \
+              -H "Authorization: token $GITHUB_TOKEN" \
+              --data "{ \"body\": \"${1}\" }"
+          }
+
           sed -i 's/\/\/\s*"strictNullChecks":\s*true,/"strictNullChecks": true,/' "current/tsconfig.json"
           sed -i 's/\/\/\s*"strictNullChecks":\s*true,/"strictNullChecks": true,/' "main/tsconfig.json"
 
@@ -56,8 +66,8 @@ jobs:
           MAIN=$(grep "Found [0-9]* errors" .out-main | sed 's/Found \(.*\) errors in .* files./\1/')
 
           if [ $CURRENT -gt $MAIN ]; then
+            comment "After enabling strictNullChecks this PR would be increasing the number of null check errors from ${MAIN} to ${CURRENT}. Make sure your branch is up-to-date with ${MAIN_BRANCH} and check the diff in the console output to gather more details"
             diff .out-current .out-main
-            echo "The PR is increasing the number of null check errors from ${MAIN} to ${CURRENT}. Check if your branch is up-to-date and consider fixing them before merging. The diff above should give you some details"
             exit 1
           else
             echo "The PR has $CURRENT null check errors against $MAIN in main. You're good to go!"
diff --git a/src/lib/util/parseEnvVar.ts b/src/lib/util/parseEnvVar.ts
index 7bc5d1b50e6..91d5db0f763 100644
--- a/src/lib/util/parseEnvVar.ts
+++ b/src/lib/util/parseEnvVar.ts
@@ -9,7 +9,7 @@ export function parseEnvVarNumber(envVar: string, defaultVal: number): number {
 }
 
 export function parseEnvVarBoolean(
-    envVar: string,
+    envVar: string | undefined,
     defaultVal: boolean,
 ): boolean {
     if (envVar) {