Add code comment

cooldev900 · Aug 15, 2024 · 0028718 · 0028718
1 parent 209a0e2
commit 0028718
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/.github/actions/javascript/getDeployPullRequestList/getDeployPullRequestList.ts b/.github/actions/javascript/getDeployPullRequestList/getDeployPullRequestList.ts
@@ -34,6 +34,9 @@ async function run() {
         let sameAsInputTag = false;
         let wrongEnvironment = false;
         let unsuccessfulDeploy = false;
+
+        // note: this while statement looks a bit weird because uses assignment as a condition: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/while#using_an_assignment_as_a_condition
+        // while ugly, it's beneficial in this case because it prevents extra network requests from happening unnecessarily (i.e: we only check wrongEnvironment if sameAsInputTag is false, etc...)
         while (
             (invalidReleaseBranch = !!lastSuccessfulDeploy?.head_branch) &&
             ((sameAsInputTag = lastSuccessfulDeploy?.head_branch === inputTag) ||

diff --git a/.github/actions/javascript/getDeployPullRequestList/index.js b/.github/actions/javascript/getDeployPullRequestList/index.js
@@ -11526,6 +11526,8 @@ async function run() {
         let sameAsInputTag = false;
         let wrongEnvironment = false;
         let unsuccessfulDeploy = false;
+        // note: this while statement looks a bit weird because uses assignment as a condition: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/while#using_an_assignment_as_a_condition
+        // while ugly, it's beneficial in this case because it prevents extra network requests from happening unnecessarily (i.e: we only check wrongEnvironment if sameAsInputTag is false, etc...)
         while ((invalidReleaseBranch = !!lastSuccessfulDeploy?.head_branch) &&
             ((sameAsInputTag = lastSuccessfulDeploy?.head_branch === inputTag) ||
                 (wrongEnvironment =