Skip to content

CHANGELOG.md

Latest commit

 

History

History
64 lines (50 loc) · 3.52 KB

CHANGELOG.md

File metadata and controls

64 lines (50 loc) · 3.52 KB

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

v1.12.0 - 2026-04-12

Added

  • HTML reporter — interactive dashboard with 4 comparison modes (both/base/new/heatmap), per-image zoom, keyboard navigation, and search (#170)
  • GitHub Actions integration — inline HTML preview with base64 embedded images + reusable composite action (#171)
  • disable_animations helper — inject CSS to stop all animations/transitions during screenshots (#174)
  • snap_diff:clean rake task — remove diff artifacts while keeping baselines (#177)
  • Diff.compare for standalone image comparison without Capybara or browser
  • Perceptual color distance (dE00) for anti-aliasing tolerance in VipsDriver
  • assert_no_screenshot_changes DSL assertion
  • Diff.configure block helper for simplified configuration
  • Ruby 3.5 and 4.0 support

Changed

  • blur_active_element now defaults to true — prevents cursor blinking artifacts
  • hide_caret now defaults to true — stable screenshots without caret
  • fail_if_new now defaults to true in CI (when ENV['CI'] is set)
  • Thread-safe reporter notification with mutex (#175)

Removed

  • SVN support — Git only
  • ActiveSupport runtime dependency — pure Ruby, lighter installations

Fixed

  • VCS path resolution rewritten for thread safety (Open3 + array-form system)
  • Reporter diff artifacts cleaned up properly on Snap#delete! (#173)
  • RSpec matcher now provides failure_message and description
  • Missing baseline error includes recording instructions
  • Ruby 4.0 DSLStub ordering compatibility
  • ChunkyPNG filter_image_with_median incorrect behavior
  • Tolerance calculation no longer skips large changes

Performance

  • ChunkyPNG shift-detection: eliminated array allocations (~30% faster for large images)
  • VIPS: cached computations at construction (~15% faster)
  • Memoized region area size, replaced closures with blocks

Documentation

  • README restructured from 970 to 149 lines with 7 dedicated docs/ files (#171)
  • CI integration guide with artifact upload and PR commenting (docs/ci-integration.md)
  • Upgrade guide (docs/UPGRADING.md)
  • Color comparison guide — tolerance vs perceptual_threshold vs color_distance_limit (#176)

Internal

  • Simplified internals: inlined CaptureStrategy, ComparisonLoader, ScreenshotNamerDSL, VipsUtil
  • Unified Screenshoter constructors, consolidated skip_area accessor
  • Upgraded CI dependencies (actions/checkout v5, upload-artifact v7)

v1.11.0 - Previous Release

Upgrade Guide: See docs/UPGRADING.md for detailed migration instructions.