Skip to content

chore: prepare v2.0.0.beta4 - #286

Merged
pftg merged 1 commit into
masterfrom
release/2-0-0-beta4
Aug 24, 2026
Merged

chore: prepare v2.0.0.beta4#286
pftg merged 1 commit into
masterfrom
release/2-0-0-beta4

Conversation

@pftg

@pftg pftg commented Aug 24, 2026

Copy link
Copy Markdown
Collaborator

Prepares the 2.0.0.beta4 prerelease. Docs, CHANGELOG and version only — no code changes.

beta3 fixed the canonical entry points and shipped almost none of the behaviour. beta4 is the
prerelease the [v2.0.0] CHANGELOG entry actually describes: the four green-suite bugs
(#254 #255 #256 #258), the accept workflow (#259), the legible failure message (#264), and the
deprecation warnings that make 2.1's removals visible (#246 #263).

If you are on beta3, this is not an optional bump — beta3 still passes green on a screenshot
it never compared.

What's in the diff

Verification

The release workflow's version guard reads a different constant than the one bumped
(Capybara::Screenshot::Diff::VERSION, via the legacy shim), so it was run exactly as
release.yml does rather than assumed:

$ ruby -I lib -r capybara/screenshot/diff/version -e "puts Capybara::Screenshot::Diff::VERSION"
2.0.0.beta4
Gate Result
rake test (both suites) 757 runs, 2209 assertions, 0 failures, 0 errors, 1 skip
standardrb 170 files, 0 offenses
gem build capybara-screenshot-diff-2.0.0.beta4.gem — 93 files, 13 docs, RELEASE_PREP excluded
grep PLACEHOLDER 0
stale beta3 pins 0 outside CHANGELOG history

The single skip is pre-existing: CI's own pre-#283 run reported 757 runs … 1 skips too. What
changed there is 6 errors → 0 errors.

The caveat, stated in the release notes

Removing skip_area's implicit stabilization wait (#272, measured 10.012 s → 0.009 s) means a
selector not yet in the DOM now yields no mask, silently, where it previously resolved after
the wait. #277's run-level tally shipped in the same beta as the replacement signal — the notes
say so rather than leaving a user to find out from a flaky mask.

After merge

Dispatch Actions → Release with input 2.0.0.beta4, then verify both gem names published at
the same version (a version under only one name is the failure mode to watch — the dual-install
guard assumes they never diverge), then re-verify against a real consumer.

Summary by Sourcery

Prepare the 2.0.0.beta4 prerelease by updating the version and aligning release documentation and installation pins.

Enhancements:

  • Document the beta4 behavior changes, record modes, reporting improvements, deprecations, performance updates, and skip-area caveat in the changelog.
  • Update prerelease installation guidance and migration checklists to pin version 2.0.0.beta4.

Documentation:

  • Add the v2.0.0.beta4 changelog entry and replace the record-mode placeholder with guidance for accepting screenshot changes.

Chores:

  • Bump the gem version from 2.0.0.beta3 to 2.0.0.beta4.

Summary by CodeRabbit

  • Release

    • Updated the package to version 2.0.0.beta4.
    • Added release notes covering record modes, verification summaries, readiness checks, deprecations, bug fixes, and performance improvements.
  • Documentation

    • Updated installation, upgrade, migration, and release preparation examples to use version 2.0.0.beta4.
    • Documented record-mode behavior, missing baselines, and readiness considerations.

beta3 fixed the canonical entry points and shipped almost none of the behaviour.
beta4 is the prerelease the 2.0.0 entry actually describes: the four green-suite
bugs (#254 #255 #256 #258), the accept workflow (#259), the legible failure
message (#264), and the deprecation warnings that make 2.1's removals visible
(#246 #263).

- `lib/snap_diff/version.rb` -> 2.0.0.beta4. Nothing else holds a version; the
  gemspec, the legacy version file and the mirror gemspec all read it. Verified
  with the release workflow's own guard command:
  `ruby -I lib -r capybara/screenshot/diff/version -e "puts Capybara::Screenshot::Diff::VERSION"`
  => 2.0.0.beta4
- CHANGELOG: a `[v2.0.0.beta4]` section written as the delta from beta3, plus the
  record-modes PLACEHOLDER filled from #259 now that it has shipped.
  `grep -n PLACEHOLDER CHANGELOG.md` returns nothing.
- Install snippets moved beta3 -> beta4 in README, docs/UPGRADING.md and
  docs/migration-guide.md. They stay PINNED: `~> 2.0` resolves to nothing while
  only prereleases exist, so unpinning belongs to 2.0.0 final, not here.

The notes name the #272 caveat explicitly. Removing `skip_area`'s implicit
stabilization wait (10.012 s -> 0.009 s measured) means a selector not yet in
the DOM now yields no mask, silently, where it previously resolved after the
wait. #277's run-level tally shipped in the same beta as the replacement signal,
and the notes say so rather than leaving it to be discovered.

Gates: `rake test:unit` 720 runs / 2124 assertions / 0 failures / 0 skips under
CI=true on 4.0.6, `standardrb lib test` clean over 161 files, and
`gem build` produces capybara-screenshot-diff-2.0.0.beta4.gem (93 files, 13 docs,
RELEASE_PREP correctly excluded).

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Sorry @pftg, you have reached your weekly rate limit of 250000 diff characters.

Please try again later or upgrade to continue using Sourcery

@sourcery-ai

sourcery-ai Bot commented Aug 24, 2026

Copy link
Copy Markdown
Contributor

Reviewer's Guide

Prepares the 2.0.0.beta4 prerelease without production code changes by bumping the sole version constant, documenting the shipped behavior and known skip_area caveat, completing record-mode release notes, and updating all current prerelease installation pins and release guidance.

File-Level Changes

Change Details Files
Bump the library to the beta4 prerelease and align release-preparation guidance.
  • Update the canonical version constant to 2.0.0.beta4.
  • Adjust release checklist instructions for replacing beta4 pins at final release.
lib/snap_diff/version.rb
docs/RELEASE_PREP.md
Document the beta4 behavior delta, release caveats, and completed record-mode workflow.
  • Add the beta4 changelog section covering fixes, performance changes, deprecations, record modes, reporting/readiness features, and the skip_area caveat.
  • Replace the record-mode placeholder with usage and CI guidance.
  • Update historical upgrade snippets to beta4.
CHANGELOG.md
Update user-facing installation and upgrade instructions to target the beta4 prerelease.
  • Replace beta3 pins with exact beta4 pins in installation and migration examples.
  • Update the upgrade checklist to reference beta4.
README.md
docs/UPGRADING.md
docs/migration-guide.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@coderabbitai

coderabbitai Bot commented Aug 24, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: d597d9bf-4d32-4baf-87e1-62e4ea62d02b

📥 Commits

Reviewing files that changed from the base of the PR and between 5e5ec9e and 15e1ce3.

📒 Files selected for processing (6)
  • CHANGELOG.md
  • README.md
  • docs/RELEASE_PREP.md
  • docs/UPGRADING.md
  • docs/migration-guide.md
  • lib/snap_diff/version.rb

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

The project version changed to 2.0.0.beta4. Installation, upgrade, migration, and release checklist references were updated. The changelog documents record modes and beta4 release changes.

Changes

Beta4 release update

Layer / File(s) Summary
Beta4 version and installation references
lib/snap_diff/version.rb, README.md, docs/UPGRADING.md, docs/migration-guide.md, CHANGELOG.md, docs/RELEASE_PREP.md
The version constant and prerelease installation references now use 2.0.0.beta4.
Beta4 upgrade and release notes
CHANGELOG.md
The changelog documents record modes, missing-baseline behavior, verification summaries, readiness blocks, deprecation warnings, fixes, performance changes, and unmatched skip_area behavior.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Merge Risk: ⚪ Minimal · up to 15e1c

This PR updates the prerelease version and aligns release documentation and installation guidance; no actionable merge-blocking risk remains after normal checks and review.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the preparation of the v2.0.0.beta4 prerelease.
Docstring Coverage ✅ Passed Docstring check was indeterminate for this PR — some files could not be analyzed in time. Not blocking.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch release/2-0-0-beta4

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@pftg
pftg merged commit db591a2 into master Aug 24, 2026
8 checks passed
@pftg
pftg deleted the release/2-0-0-beta4 branch August 24, 2026 16:52
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.

1 participant