Merge pull request #372 from Infineon/371-bug-pr-preview-deployment-a…

…ction-of-storybook-not-updating-comment-on-github-concurrency-issue workflow bug fix
Infineon · Aug 11, 2023 · ea2c31a · ea2c31a
2 parents 85f5a90 + c5fa091
commit ea2c31a
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 26 deletions.
diff --git a/.github/workflows/github_pages_storybook_preview.yml b/.github/workflows/github_pages_storybook_preview.yml
@@ -52,28 +52,35 @@ jobs:
         run: |
           echo "Preview URL: ${{ steps.preview.outputs.deployment-url }}"
 
-      - name: Update comment in PR
+      - name: Update comment in PR # add comment on github
         uses: actions/github-script@v4
         with:
           script: |
             const prNumber = context.payload.pull_request.number;
+            const STORYBOOK_IDENTIFIER = "--STORYBOOK-PREVIEW--";
+            const newText = `--STORYBOOK-PREVIEW--\n- PR Preview URL for Storybook: ${{ steps.preview.outputs.deployment-url }}`;
+
             const {data: comments} = await github.issues.listComments({
               owner: context.repo.owner,
               repo: context.repo.repo,
               issue_number: prNumber
             });
-            const autoComment = comments.find(c => c.user.login === 'github-actions[bot]');
-            if (autoComment) {
-              const existingText = autoComment.body;
-              const newText = '\n- PR Preview URL for Storybook: ${{ steps.preview.outputs.deployment-url }}';
-              if (!existingText.includes(newText)) {
-                await github.issues.updateComment({
-                  owner: context.repo.owner,
-                  repo: context.repo.repo,
-                  comment_id: autoComment.id,
-                  body: `${existingText}\n${newText}`
-                });
-              }
+            const storybookComment = comments.find(c => c.body.startsWith(STORYBOOK_IDENTIFIER));
+
+            if (storybookComment) {
+              await github.issues.updateComment({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                comment_id: storybookComment.id,
+                body: newText
+              });
+            } else {
+              await github.issues.createComment({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                issue_number: prNumber,
+                body: newText
+              });
             }
         env:
           GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
diff --git a/.github/workflows/shipit_pr_and_example_apps_deployment.yml b/.github/workflows/shipit_pr_and_example_apps_deployment.yml
@@ -207,7 +207,7 @@ jobs:
           umbrella-dir: pr-preview-vanilla-example
           token: ${{ secrets.GH_TOKEN }}
 
-  update-pr-comment: 
+  update-pr-comment: # add comment on github
     needs: [deploy-preview-vue, deploy-preview-react, deploy-preview-angular, deploy-preview-vanilla]
     runs-on: ubuntu-latest
     steps:
@@ -222,24 +222,23 @@ jobs:
             const reactUrl = "${{ needs.deploy-preview-react.outputs.deployment-url }}";
             const angularUrl = "${{ needs.deploy-preview-angular.outputs.deployment-url }}";
             const vanillaUrl = "${{ needs.deploy-preview-vanilla.outputs.deployment-url }}";
-            const newText = `PR Preview URLs:\n- Vue example: ${vueUrl}\n- React example: ${reactUrl}\n- Angular example: ${angularUrl}\n- Vanilla example: ${vanillaUrl}`;
+            const EXAMPLE_APPS_IDENTIFIER = "--EXAMPLE-APPS-PREVIEW--";
+            const newText = `--EXAMPLE-APPS-PREVIEW--\nPR Preview URLs:\n- Vue example: ${vueUrl}\n- React example: ${reactUrl}\n- Angular example: ${angularUrl}\n- Vanilla example: ${vanillaUrl}`;
   
             const {data: comments} = await github.issues.listComments({
               owner: context.repo.owner,
               repo: context.repo.repo,
               issue_number: prNumber
             });
-            const autoComment = comments.find(c => c.user.login === 'github-actions[bot]');
-            if (autoComment) {
-              const existingText = autoComment.body;
-              if (!existingText.includes(newText)) {
-                await github.issues.updateComment({
-                  owner: context.repo.owner,
-                  repo: context.repo.repo,
-                  comment_id: autoComment.id,
-                  body: `${existingText}\n${newText}`
-                });
-              } 
+            const appsComment = comments.find(c => c.body.startsWith(EXAMPLE_APPS_IDENTIFIER));
+
+            if (appsComment) {
+              await github.issues.updateComment({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                comment_id: appsComment.id,
+                body: newText
+              });
             } else {
               await github.issues.createComment({
                 owner: context.repo.owner,