🐛 (svg tester) fix svg tester action when running in parallel

owid · Mar 6, 2024 · be30643 · be30643
1 parent d876868
commit be30643
Show file tree

Hide file tree

Showing 2 changed files with 47 additions and 10 deletions.
diff --git a/.github/workflows/svg-compare-all-views.yml b/.github/workflows/svg-compare-all-views.yml
@@ -1,8 +1,8 @@
 name: SVG diff (all views)
-on: workflow_dispatch
+on: [push, pull_request]
 
 jobs:
-    svgTester:
+    svgTesterAllViews:
         runs-on: ubuntu-latest
 
         steps:
@@ -12,19 +12,25 @@ jobs:
             - uses: ./.github/actions/setup-node-yarn-deps
             - uses: ./.github/actions/build-tsc
 
+            # Set branch names and token to be used for pushing to the owid-grapher-svgs repo.
+            # If on a feature branch, create a branch in the owid-grapher-svgs repo with the same name plus a suffix
+            # to differentiate it from the branch created by the svgTester job.
+            # If on master, create a new branch with the current timestamp (and suffix) that will be later merged into master.
             - name: Set branch name and token for OWID runs
               if: ${{ github.repository_owner == 'owid' }}
               shell: bash
               run: |
-                  [[ ${{ github.ref_name }} = 'master' ]] && suffix="" || suffix="__all-views"
+                  [[ ${{ github.ref_name }} = 'master' ]] && suffix="__$(date +%s)__all-views" || suffix="__all-views"
+                  echo "ORIGINAL_BRANCH_NAME=${{ github.ref_name }}" >> $GITHUB_ENV
                   echo "PUSH_BRANCH_NAME=${{ github.ref_name }}$suffix" >> $GITHUB_ENV
                   echo "TOKEN=${{ secrets.GITHUBPAT }}" >> $GITHUB_ENV
 
             - name: Set branch name and token for runs from a fork
               if: ${{ github.repository_owner != 'owid' }}
               shell: bash
               run: |
-                  [[ ${{ github.ref_name }} = 'master' ]] && suffix="" || suffix="__all-views"
+                  [[ ${{ github.ref_name }} = 'master' ]] && suffix="__$(date +%s)__all-views" || suffix="__all-views"
+                  echo "ORIGINAL_BRANCH_NAME=${{ github.ref_name }}" >> $GITHUB_ENV
                   echo "PUSH_BRANCH_NAME=${{ github.repository_owner }}/${{ github.ref_name }}$suffix" >> $GITHUB_ENV
                   echo "TOKEN=${{ github.token }}" >> $GITHUB_ENV
 
@@ -51,7 +57,7 @@ jobs:
               continue-on-error: true
               env:
                   # using "ternary operator" from https://github.com/actions/runner/issues/409#issuecomment-752775072
-                  RM_ON_ERROR: ${{ env.PUSH_BRANCH_NAME == 'master' && '' || '--rm-on-error' }}
+                  RM_ON_ERROR: ${{ env.ORIGINAL_BRANCH_NAME == 'master' && '' || '--rm-on-error' }}
               run: node --enable-source-maps itsJustJavascript/devTools/svgTester/verify-graphs.js -i owid-grapher-svgs/configs -o owid-grapher-svgs/all-views/svg -r owid-grapher-svgs/all-views/svg --ids-from-file owid-grapher-svgs/most-viewed-charts.txt --all-views $RM_ON_ERROR > compare-result
 
             # If the last step failed we want to commit all changed svgs and push them to the new branch on the owid-grapher-svgs repo
@@ -63,6 +69,18 @@ jobs:
                   push_options: "--force"
                   commit_message: Automated commit with svg differences (all views) triggered by commit https://github.com/owid/owid-grapher/commit/${{github.sha}}
 
+            # Merge differences into owid-grapher-svgs master if we are on master in owid-grapher
+            - name: Merge into owid-grapher-svgs master
+              if: ${{ steps.run-verify-graphs.outcome == 'failure' && env.ORIGINAL_BRANCH_NAME == 'master' }}
+              working-directory: owid-grapher-svgs
+              run: |
+                  git config user.name "${GITHUB_ACTOR}"
+                  git config user.email "${GITHUB_ACTOR}@users.noreply.github.com"
+                  git checkout master
+                  git pull origin master
+                  git merge -s ort -X theirs -m 'Automated merge commit with svg differences (all views) triggered by commit https://github.com/owid/owid-grapher/commit/${{github.sha}}' ${{ env.PUSH_BRANCH_NAME }}
+                  git push --force origin master
+
             # The action fails if there were any errors.
             - name: Fail with error message if we had errors
               if: ${{ steps.run-verify-graphs.outputs.num_errors > 0 }}
@@ -76,7 +94,7 @@ jobs:
             # reason to mark this action as failed.
             - name: Fail with error message if we had differences
               if: ${{ steps.run-verify-graphs.outputs.num_differences > 0 }}
-              continue-on-error: ${{ env.PUSH_BRANCH_NAME == 'master' }}
+              continue-on-error: ${{ env.ORIGINAL_BRANCH_NAME == 'master' }}
               uses: actions/github-script@v6
               with:
                   script: |

diff --git a/.github/workflows/svg-compare.yml b/.github/workflows/svg-compare.yml
@@ -12,18 +12,25 @@ jobs:
             - uses: ./.github/actions/setup-node-yarn-deps
             - uses: ./.github/actions/build-tsc
 
+            # Set branch names and token to be used for pushing to the owid-grapher-svgs repo.
+            # If on a feature branch, create a new branch in the owid-grapher-svgs repo with the same name.
+            # If on master, create a new branch with the current timestamp that will be later merged into master.
             - name: Set branch name and token for OWID runs
               if: ${{ github.repository_owner == 'owid' }}
               shell: bash
               run: |
-                  echo "PUSH_BRANCH_NAME=${{ github.ref_name }}" >> $GITHUB_ENV
+                  [[ ${{ github.ref_name }} = 'master' ]] && suffix="__$(date +%s)" || suffix=""
+                  echo "ORIGINAL_BRANCH_NAME=${{ github.ref_name }}" >> $GITHUB_ENV
+                  echo "PUSH_BRANCH_NAME=${{ github.ref_name }}$suffix" >> $GITHUB_ENV
                   echo "TOKEN=${{ secrets.GITHUBPAT }}" >> $GITHUB_ENV
 
             - name: Set branch name and token for runs from a fork
               if: ${{ github.repository_owner != 'owid' }}
               shell: bash
               run: |
-                  echo "PUSH_BRANCH_NAME=${{ github.repository_owner }}/${{ github.ref_name }}" >> $GITHUB_ENV
+                  [[ ${{ github.ref_name }} = 'master' ]] && suffix="__$(date +%s)" || suffix=""
+                  echo "ORIGINAL_BRANCH_NAME=${{ github.ref_name }}" >> $GITHUB_ENV
+                  echo "PUSH_BRANCH_NAME=${{ github.repository_owner }}/${{ github.ref_name }}$suffix" >> $GITHUB_ENV
                   echo "TOKEN=${{ github.token }}" >> $GITHUB_ENV
 
             # Checkout the owid-grapher-svgs repo into a subfolder. Use a Personal Access Token for checkout so the
@@ -49,7 +56,7 @@ jobs:
               continue-on-error: true
               env:
                   # using "ternary operator" from https://github.com/actions/runner/issues/409#issuecomment-752775072
-                  RM_ON_ERROR: ${{ env.PUSH_BRANCH_NAME == 'master' && '' || '--rm-on-error' }}
+                  RM_ON_ERROR: ${{ env.ORIGINAL_BRANCH_NAME == 'master' && '' || '--rm-on-error' }}
               run: node --enable-source-maps itsJustJavascript/devTools/svgTester/verify-graphs.js -i owid-grapher-svgs/configs -o owid-grapher-svgs/svg -r owid-grapher-svgs/svg $RM_ON_ERROR > compare-result
 
             # If the last step failed we want to commit all changed svgs and push them to the new branch on the owid-grapher-svgs repo
@@ -61,6 +68,18 @@ jobs:
                   push_options: "--force"
                   commit_message: Automated commit with svg differences triggered by commit https://github.com/owid/owid-grapher/commit/${{github.sha}}
 
+            # Merge differences into owid-grapher-svgs master if we are on master in owid-grapher
+            - name: Merge into owid-grapher-svgs master
+              if: ${{ steps.run-verify-graphs.outcome == 'failure' && env.ORIGINAL_BRANCH_NAME == 'master' }}
+              working-directory: owid-grapher-svgs
+              run: |
+                  git config user.name "${GITHUB_ACTOR}"
+                  git config user.email "${GITHUB_ACTOR}@users.noreply.github.com"
+                  git checkout master
+                  git pull origin master
+                  git merge -s ort -X theirs -m 'Automated merge commit with svg differences triggered by commit https://github.com/owid/owid-grapher/commit/${{github.sha}}' ${{ env.PUSH_BRANCH_NAME }}
+                  git push --force origin master
+
             # The action fails if there were any errors.
             - name: Fail with error message if we had errors
               if: ${{ steps.run-verify-graphs.outputs.num_errors > 0 }}
@@ -74,7 +93,7 @@ jobs:
             # reason to mark this action as failed.
             - name: Fail with error message if we had differences
               if: ${{ steps.run-verify-graphs.outputs.num_differences > 0 }}
-              continue-on-error: ${{ env.PUSH_BRANCH_NAME == 'master' }}
+              continue-on-error: ${{ env.ORIGINAL_BRANCH_NAME == 'master' }}
               uses: actions/github-script@v6
               with:
                   script: |