kien-ht / cypress-image-diff-html-report

A HTML reporting module for Cypress-Image-Diff to parse the JSON output into a beautiful report
MIT License
18 stars 1 forks source link

feat: ⭐ Cypress Image Diff Html Report Github App - Github Actions #14

Open kien-ht opened 2 months ago

kien-ht commented 2 months ago

Hosting our own Github App. Main features:

The goal is to create a Github App in the marketplace that is capable of providing the above features at zero cost. There are free web hosting options out there but obviously with storage and computing limits. Therefore, I'm trying to make our server handling tasks as lightweight as possible.

To get the test results for every pull request, we need to integrate with a CI provider, starting off with Github Actions which offers free computing usage for standard GitHub-hosted runners in public repositories. There is a slight challenge in delivering screenshots to clients as Github workflow artifacts come as zips. We might not want to host any screenshots because the storage could ramp up quickly, even temporarily. We could convert all screenshots to base64 during the report generation, though it saves some server storage but it will definitely consume much more bandwidth, roughly about 33% more for every image request because that's how much a base64 image is heavier, let alone the baseline update payload that will include as many raw base64 images as users want for every request. There are tradeoffs, but to start off, I'll go with base64 images for easier implementation and let's see our bandwidth consumption.

Here is how it goes roughly:

After Github Actions, next step would be integration with other popular CI providers. We don't have a clear plan yet. We'll develop as we go.

If you have any good candidates for a free hosting server that fits our purpose, please come forward. I'd much appreciate it.

vercel[bot] commented 2 months ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
cypress-image-diff-html-report ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 9, 2024 11:40am
netlify[bot] commented 2 months ago

Deploy Preview for cypress-image-diff canceled.

Name Link
Latest commit 16bc821c7cb6c014952e3df0b8f933d33b909db0
Latest deploy log https://app.netlify.com/sites/cypress-image-diff/deploys/66545ff3514cc10008179abe