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

Improve the DVC image diff workflow to support side-by-side comparison of modified images #1219

Merged
merged 4 commits into from
Apr 21, 2021

Conversation

seisman
Copy link
Member

@seisman seisman commented Apr 21, 2021

Description of proposed changes

This PR improves the DVC image diff workflow, so that it shows side-by-side comparisons of modified images in a markdown table.

NOTE: commit cff85bf is only for testing this the new workflow, and will be removed before merging. In this commit, one image is added, one is removed and one is modified, so it should cover all the possible use cases.

Address #1217.

Reminders

  • Run make format and make check to make sure the code follows the style guide.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Add new public functions/methods/classes to doc/api/index.rst.
  • Write detailed docstrings for all functions/methods.
  • If adding new functionality, add an example to docstrings or tutorials.

Slash Commands

You can write slash commands (/command) in the first line of a comment to perform
specific operations. Supported slash commands are:

  • /format: automatically format and lint the code
  • /test-gmt-dev: run full tests on the latest GMT development version

@github-actions
Copy link
Contributor

github-actions bot commented Apr 21, 2021

Summary of changed images

This is an auto-generated report of images that have changed on the DVC remote

Status Path
added pygmt/tests/baseline/test_basemap_add.png
deleted pygmt/tests/baseline/test_basemap_map_scale.png
modified pygmt/tests/baseline/test_basemap_compass.png

Image diff(s)

Added images

  • pygmt/tests/baseline/test_basemap_add.png

Modified images

Path Old New
test_basemap_compass.png

Report last updated at commit 7d14988

@seisman seisman added this to the 0.4.0 milestone Apr 21, 2021
@seisman seisman added the maintenance Boring but important stuff for the core devs label Apr 21, 2021
@seisman seisman force-pushed the dvc-diff branch 2 times, most recently from 6c6187f to 87ed356 Compare April 21, 2021 05:40
@seisman seisman marked this pull request as ready for review April 21, 2021 05:54
@seisman
Copy link
Member Author

seisman commented Apr 21, 2021

See #1219 (comment) for the new image diff report.

@seisman seisman mentioned this pull request Apr 21, 2021
3 tasks
@seisman seisman added the final review call This PR requires final review and approval from a second reviewer label Apr 21, 2021
Copy link
Member

@michaelgrund michaelgrund left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me!

@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Apr 21, 2021
sixy6e pushed a commit to sixy6e/pygmt that referenced this pull request Dec 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance Boring but important stuff for the core devs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants