🐝 (svg tester) add GitHub action to test all possible chart views #3062

sophiamersmann · 2024-01-04T09:33:21Z

Adds a GitHub action to test all possible views of a subset of charts
The action works exactly like the other action works
- To review, it's probably easiest to look at the diff between svg-compare.yml and svg-compare-all-views.yml
Both actions commit to the same branch in owid-grapher-svgs
- Having all SVGs for one change on the same branch is convenient since I often pull from the repo to look at the SVG differences locally (if there are many differences, GitHub often fails too to load the page)
- Accidental content overwrites are impossible because both actions operate in different directories
The verify step:
- The verify script reads chart IDs to process from the most-viewed-charts.txt file in owid-grapher-svgs
- The reference SVGs for all chart views are stored in all-views/svg
- Reference SVGs and the most-viewed-charts.txt text file are added to the owid-grapher-svgs repo in Add reference SVGs for all chart views of a subset of charts owid-grapher-svgs#12

I couldn't get act to run actions locally, so this GitHub action is not tested in any way
That's why for now the action is configured to not run automatically. It can only be triggered by the click of a button on GitHub.
Once it's properly tested, I'd configure it to run on push/pull.

sophiamersmann · 2024-01-04T09:33:30Z

Current dependencies on/for this PR:

master
- PR 🐝 (svg tester) test hidden chart views #3043
  - PR 🐝 (svg tester) add GitHub action to test all possible chart views #3062 👈

This stack of pull requests is managed by Graphite.

sophiamersmann · 2024-01-10T09:22:54Z

.github/workflows/svg-compare.yml

            # but only do this if we are not on master in owid-graphers (in this case we want to commit and push on master
            # in owid-grapher-svgs as well)
            - name: create owid-grapher-svgs local branch
              if: ${{ env.PUSH_BRANCH_NAME != 'master'}}
              working-directory: owid-grapher-svgs
-              run: git branch ${{ env.PUSH_BRANCH_NAME }} && git checkout ${{ env.PUSH_BRANCH_NAME }}
+              continue-on-error: true


If both actions commit to the same branch in owid-grapher-svgs, then creating a branch should be a no-op if the branch already exists. git branch <b> fails with exit code 1 if <b> exists, that's why I set continue-on-error to true. I wasn't sure whether the next line (the checkout) would run if the previous line failed. To be on the safe side, the branch is checked out in a separate step.

sophiamersmann · 2024-01-10T09:25:08Z

.github/workflows/svg-compare-all-views.yml

@@ -0,0 +1,88 @@
+name: SVG diff (all views)
+on: workflow_dispatch


For now, this action can only be triggered by a click of a button on GitHub. Once it's properly tested (and I'm sure it actually gives useful feedback), I would set this to push/pull.

sophiamersmann · 2024-01-10T09:28:13Z

.github/workflows/svg-compare-all-views.yml

+              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' }}
+              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


This is the only line of code that is meaningfully different compared to the other action.

…-svgs

… exists

danyx23

Looks good! Let's merge this and see if there are any issues when running manually but I'm very excited to have this soon for all commits :)

sophiamersmann mentioned this pull request Jan 4, 2024

🐝 (svg tester) test hidden chart views #3043

Merged

sophiamersmann changed the title ~~SVG tester: Add GitHub action to test all views~~ 🐝 SVG tester: Add GitHub action to test all views Jan 4, 2024

github-actions bot assigned sophiamersmann Jan 4, 2024

sophiamersmann force-pushed the svg-tester-action-all-views branch from e9ad638 to 993efdd Compare January 4, 2024 12:53

sophiamersmann force-pushed the svg-tester branch from 7561999 to 75fafce Compare January 5, 2024 09:59

sophiamersmann force-pushed the svg-tester-action-all-views branch 2 times, most recently from 8859888 to dd35855 Compare January 5, 2024 15:16

sophiamersmann force-pushed the svg-tester branch from 2ebe3dc to 8869eb9 Compare January 5, 2024 15:52

sophiamersmann force-pushed the svg-tester-action-all-views branch from dd35855 to f5ee770 Compare January 5, 2024 15:52

sophiamersmann force-pushed the svg-tester branch from 8869eb9 to 69d19c7 Compare January 5, 2024 16:23

sophiamersmann force-pushed the svg-tester-action-all-views branch from f5ee770 to 29b4749 Compare January 5, 2024 16:23

sophiamersmann mentioned this pull request Jan 5, 2024

Add reference SVGs for all chart views of a subset of charts owid/owid-grapher-svgs#12

Merged

sophiamersmann marked this pull request as ready for review January 5, 2024 16:38

sophiamersmann changed the title ~~🐝 SVG tester: Add GitHub action to test all views~~ 🐝 (svg tester) add GitHub action to test all possible chart views Jan 8, 2024

sophiamersmann force-pushed the svg-tester-action-all-views branch 2 times, most recently from d987a2c to b5e2e6d Compare January 9, 2024 13:34

sophiamersmann force-pushed the svg-tester branch from 56d8716 to 264005f Compare January 10, 2024 09:08

sophiamersmann force-pushed the svg-tester-action-all-views branch from b5e2e6d to ecc2bce Compare January 10, 2024 09:08

sophiamersmann commented Jan 10, 2024

View reviewed changes

sophiamersmann force-pushed the svg-tester-action-all-views branch from 2b24182 to 45a6a99 Compare January 10, 2024 10:00

sophiamersmann force-pushed the svg-tester branch from b2a8cba to 7c77388 Compare January 10, 2024 11:02

sophiamersmann force-pushed the svg-tester-action-all-views branch from 45a6a99 to 8129dc0 Compare January 10, 2024 11:02

sophiamersmann requested a review from danyx23 January 10, 2024 13:41

sophiamersmann force-pushed the svg-tester-action-all-views branch from 8129dc0 to dbca493 Compare January 12, 2024 09:35

sophiamersmann force-pushed the svg-tester branch from 5e617c5 to c9f9078 Compare January 22, 2024 10:36

sophiamersmann force-pushed the svg-tester-action-all-views branch from dbca493 to 4fc2c94 Compare January 22, 2024 10:36

🐝 (svg-tester) add GitHub action to test all views

b9a9ceb

sophiamersmann added 7 commits January 22, 2024 11:00

🐝 (svg-tester) test a subset of charts only

31ddc43

🐝 (svg-tester) verify all chart views

5185746

🐝 (svg-tester) update path in action

caaf0a8

🐝 (svg-tester) push both svg diffs to the same branch in owid-grapher…

c928c4e

…-svgs

🐝 (svg-tester) continue if branch can't be created because it already…

262990b

… exists

🐝 (svg-tester) split branch creation & checkout step

071e08b

🐝 (svg-tester) update commit message

b06d131

sophiamersmann force-pushed the svg-tester-action-all-views branch from 4fc2c94 to b06d131 Compare January 22, 2024 11:00

Base automatically changed from svg-tester to master January 22, 2024 12:00

danyx23 approved these changes Jan 29, 2024

View reviewed changes

sophiamersmann merged commit 735148e into master Feb 2, 2024
18 checks passed

sophiamersmann deleted the svg-tester-action-all-views branch February 2, 2024 08:51

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

🐝 (svg tester) add GitHub action to test all possible chart views #3062

🐝 (svg tester) add GitHub action to test all possible chart views #3062

sophiamersmann commented Jan 4, 2024 •

edited

Loading

sophiamersmann commented Jan 4, 2024 •

edited

Loading

sophiamersmann Jan 10, 2024

sophiamersmann Jan 10, 2024 •

edited

Loading

sophiamersmann Jan 10, 2024 •

edited

Loading

danyx23 left a comment

		@@ -0,0 +1,88 @@
		name: SVG diff (all views)
		on: workflow_dispatch

🐝 (svg tester) add GitHub action to test all possible chart views #3062

🐝 (svg tester) add GitHub action to test all possible chart views #3062

Conversation

sophiamersmann commented Jan 4, 2024 • edited Loading

sophiamersmann commented Jan 4, 2024 • edited Loading

sophiamersmann Jan 10, 2024

Choose a reason for hiding this comment

sophiamersmann Jan 10, 2024 • edited Loading

Choose a reason for hiding this comment

sophiamersmann Jan 10, 2024 • edited Loading

Choose a reason for hiding this comment

danyx23 left a comment

Choose a reason for hiding this comment

sophiamersmann commented Jan 4, 2024 •

edited

Loading

sophiamersmann commented Jan 4, 2024 •

edited

Loading

sophiamersmann Jan 10, 2024 •

edited

Loading

sophiamersmann Jan 10, 2024 •

edited

Loading