Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add image comparison #2153

Merged
merged 2 commits into from
Oct 29, 2022
Merged

Conversation

jkeys089
Copy link
Contributor

Description

This PR adds a new compareImage action.

As discussed, the following new dependencies have been added:

All dependencies are MIT licensed.

  • Relevant Issues : Add screenshot comparison capability #2141
  • Type of change :
    • New feature
    • Bug fix for existing feature
    • Code quality improvement
    • Addition or Improvement of tests
    • Addition or Improvement of documentation

@jkeys089
Copy link
Contributor Author

@ptrthomas The one thing not (yet) included would be documentation about how to use the diff UI that is embedded in the Karate HTML report. It isn't very complicated but there are a few features that may be non-obvious (e.g. right-click diff image to add a new moveable / resizable ignored box, left-click existing ignored boxes to activate or deactivate them for editing, right-click an inactive ignored box to remove it, etc...).

I was thinking it might be easier to record a quick screencast (I've watched several you've recorded in the past and found them very helpful) or perhaps create a new wiki page. I could also include a section in the README if you prefer.

@ptrthomas
Copy link
Member

@jkeys089 acknowledged ! give me some time to go through this 👍

@ptrthomas
Copy link
Member

ptrthomas commented Oct 28, 2022

@jkeys089 I took a look and this is really well done. thank you for even including the documentation. I am inclined to accept this as-is and include this in the 1.3.0 release (target next 2 weeks) so that we can get some wide feedback. I'll merge over the weekend after I take one more look. thanks again !

@ptrthomas ptrthomas merged commit 5e8ea82 into karatelabs:develop Oct 29, 2022
@ptrthomas
Copy link
Member

ptrthomas commented Oct 29, 2022

@jkeys089 merged ! looks great and glad the two additional jar dependencies are tiny.

if you can record a short screencast and share the video that will be great. you can use these as a reference: https://www.youtube.com/watch?v=IDmuAREZGi0 - and I volunteer to add the on-screen annotations. (I will be able to edit and slice video, so don't worry about timing or retakes to fix mistakes)

you can propose what should appear with the timestamp etc. I'm thinking this video can also be part of the release announcement and awareness, this is indeed a feature I believe a LOT of people need today

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants