Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.

To run Reg-suit visual regression testing in GitHub Actions, first generate application screenshots or snapshots in a separate browser/test step, then run npx reg-suit run to compare them with the expected images and publish a comparison report. Reg-suit compares image files; it does not capture your application. The actualDir setting must point to the generated files.

How the workflow fits together

A useful CI pipeline has four distinct jobs:

  1. Capture: a browser or test runner opens the application and writes screenshots to disk.
  2. Select expected images: Reg-suit finds the baseline snapshot set to compare against. With the Git-hash key generator, the relevant branch history and branch identity affect that selection.
  3. Compare: Reg-suit compares the current images with the expected snapshots and creates an HTML comparison report.
  4. Publish and notify: configured plugins can store snapshots and report data, and optionally notify reviewers.

The separate reg-actions project also works with already-generated images; its README explicitly says, “So, this action does not take screenshot, please generate images by your self.”

Set up the GitHub Actions job

The following is a workflow outline, not a complete app-specific capture setup: replace the build and capture commands with the commands your project actually uses, and ensure the capture process writes the directory configured as actualDir. The official Reg-suit README includes an older example using obsolete action and Node versions, so choose currently supported versions from the actions’ official documentation rather than copying those historical pins.

name: Visual regression

on:
  pull_request:
  push:

jobs:
  visual-test:
    runs-on: ubuntu-latest
    steps:
      - name: Check out repository
        uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - name: Set up Node.js
        uses: actions/setup-node@v4
        with:
          node-version: 20
          cache: npm

      - name: Install dependencies
        run: npm ci

      - name: Build application
        run: npm run build

      - name: Generate screenshots
        run: npm run visual:capture

      - name: Compare screenshots with Reg-suit
        run: npx reg-suit run

Action major versions and the Node version shown are example pins, not a guarantee that they are the newest available or compatible with every project. Check your repository’s current runtime requirements and action documentation before adopting them. The full-history checkout is important when your selected key generator needs to inspect Git history; it is a safe starting point for the Git-hash approach, though projects using another key strategy may need a different checkout depth.

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.
#1 Best Overall
Elebase USB to USB C Adapter for iPhone 18 Pro Max,USBC Car Charger Adapter
  • Read Before You Buy — No Video Output: These adapters support charging and USB 2.0 data transfer, but cannot transmit video signals. Except for standard USB webcams (which use USB data only), they are not compatible with HDMI/DisplayPort cables, video-capable USB-C hubs, or docking stations with video output.
  • Convert USB-A Ports to USB-C: Designed to connect USB-C earphones, cables, flash drives, card readers, and other USB-C accessories to standard USB-A ports. Plug-and-play with no drivers or software required.
  • Aluminum Alloy Housing: Built with a sturdy aluminum alloy shell that aids in heat dissipation and protects against daily wear and scratches. Designed to maintain a stable and secure connection.
  • Compact & Travel-Friendly: The ultra-compact design allows the adapter to stay plugged into your device without blocking adjacent ports or adding bulk, reducing wear and tear on your original USB ports.
  • 12-Month Warranty: Backed by a 12-month manufacturer warranty for peace of mind. Designed to meet strict quality control standards for reliable everyday performance.

Make the capture command real

npm run visual:capture is a project script name used here as a placeholder for your own runnable command, not a built-in Reg-suit command. It might invoke Puppeteer, Playwright, or another test setup. That process must start or access the application, wait for the page state you intend to test, and save image files under the configured actual-image directory. The official Reg-suit Puppeteer demo shows this division: a capture script creates an image in a screenshot directory, then npx reg-suit run performs the comparison.

Configure Reg-suit and its image directory

Reg-suit configuration is kept in regconfig.json. At minimum, set core.actualDir to the directory containing the current screenshots. A minimal shape is:

{
  "core": {
    "actualDir": "screenshots"
  },
  "plugins": {}
}

Use your project’s actual directory name and add the plugins needed for snapshot keys, publishing, or notifications. In the Reg-suit model, plugins configures those separate responsibilities. The run command orchestrates syncing expected images, comparison, publishing, and any configured notification.

Rank #2
Anker USB-C Hub, 5-in-1 USB Hub for Laptops, 4K HDMI Multiport Adapter
  • 5-in-1 USB-C Hub: Experience comprehensive connectivity featuring a Power Delivery input, two USB-A 2.0 ports, a USB-A 3.0 port, and an HDMI port. (Note: The USB-C power delivery input port is only for connecting an external wall charger to power your laptop and cannot power peripheral devices.)
  • 90W Pass-Through Charging: Achieve optimal charging with 90W pass-through power to your laptop, supported by a total input of 100W, with the hub reserving 10W for operational efficiency. (Note: Wall charger not included.)
  • Quick Data Transfers: Accelerate your productivity with rapid data transfers using a high-speed 5Gbps USB 3.0 port and two 480Mbps USB 2.0 ports.
  • 4K HDMI Display: Enhance your visual experience with a hub capable of delivering 4K resolution at 30Hz in both mirror and extend modes. Please note that this hub is compatible with MacBook (macOS 12 and newer), Windows 10 and 11, ChromeOS, and laptops equipped with DP Alt Mode and Power Delivery. Note: This device is not compatible with Linux.
  • What You Get: Anker USB-C Hub (5-in-1, 4K HDMI), welcome guide, 18-month warranty, and our friendly customer service.

Comparison controls

Reg-suit documents several optional controls. Their effect depends on your images and review policy, so tune them against representative pages rather than treating any threshold as universally correct.

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.
  • workingDir can specify the working directory used by Reg-suit.
  • thresholdRate and thresholdPixel set tolerance thresholds for visual differences.
  • matchingThreshold adjusts image matching behavior.
  • enableAntialias controls antialias-related comparison handling.
  • concurrency controls concurrent comparison work.
  • x-img-diff reporting is available for visual difference reporting.

Consult the Reg-suit README for the configuration syntax and plugin-specific options matching the version installed in your project. Avoid increasing tolerances simply to silence noisy results: first check whether the capture environment, fonts, data, viewport, or timing has changed.

Choose how baselines and reports are retained

There are two documented approaches with different persistence and review characteristics:

Rank #3
Sale
Anker USB C Hub, 7in1 Multi-Port USB Adapter, 4K@60Hz USBC to HDMI Splitter
  • Sleek 7-in-1 USB-C Hub: Features an HDMI port, two USB-A 3.0 ports, and a USB-C data port, each providing 5Gbps transfer speeds. It also includes a USB-C PD input port for charging up to 100W and dual SD and TF card slots, all in a compact design.
  • Flawless 4K@60Hz Video with HDMI: Delivers exceptional clarity and smoothness with its 4K@60Hz HDMI port, making it ideal for high-definition presentations and entertainment. (Note: Only the HDMI port supports video projection; the USB-C port is for data transfer only.)
  • Double Up on Efficiency: The two USB-A 3.0 ports and a USB-C port support a fast 5Gbps data rate, significantly boosting your transfer speeds and improving productivity.
  • Fast and Reliable 85W Charging: Offers high-capacity, speedy charging for laptops up to 85W, so you spend less time tethered to an outlet and more time being productive.
  • What You Get: Anker USB-C Hub (7-in-1), welcome guide, 18-month warranty, and our friendly customer service.
Approach Who creates screenshots Storage and retention How reviewers see results Git snapshot selection
Reg-suit with publisher plugin Your browser/test step creates images before Reg-suit runs. The README lists S3 and GCS publisher plugins. S3 fetches expected snapshots and pushes actual snapshots and the comparison report; GCS is an alternative. Retention duration is not stated in the README. The comparison report is published through the configured publisher; access depends on that storage and report setup. With the Git-hash key generator, branch history is used to identify a comparison commit.
reg-actions Your browser/test step must still create the images. The action uploads test images and report as workflow artifacts. Its README documents a 30-day default artifact retention period. It can comment on a pull request and provide a workflow summary. Comment modes are always, changes, and never. It compares branch artifacts; Git-hash key-generator configuration is not described as a requirement for this approach.

Choose Reg-suit’s S3 or GCS publisher when you need the documented external snapshot/report storage model. Choose reg-actions when workflow artifacts, pull-request comments, and a workflow summary fit your review process. Artifact retention is governed by the action/repository settings, so check the configured retention before relying on a report or image remaining available.

Handle Git history and branch identity

The Git-hash key generator walks the Git branch graph to choose the commit used as the comparison base. A shallow checkout can omit the history it needs, and a detached checkout may not provide the branch name expected by the example. Start with full history via fetch-depth: 0, then confirm the event and checkout state in the Actions job logs.

Free tools Windows power users keep installed

One-click scans. No signup required.

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.

The official Reg-suit example describes a detached-HEAD workaround that supplies a branch name. Treat that as a troubleshooting option, not a mandatory step for every workflow: whether it is needed depends on the selected key generator and how the current workflow checks out the pull request or push. If comparison selects an unexpected baseline, inspect the branch/ref available to the job and the key-generator configuration before adding a workaround.

Rank #4
Sale
UGREEN USB to USB C Adapter Combo 4-Pack, 10Gbps USB C Converter Space Gray
  • Dual Converters, Infinite Potential:Includes 2× USB C male to USB A female adapters and 2× USB A male to USB C female adapters. Perfect for a wide range of uses—tablets with Bluetooth keyboards, expand USB ports on macbook, and more. Two different converters for all your daily needs
  • Next-Level 10Gbps & 3A Charging: No more slow 480Mbps, this usb to usb c adapter has a transfer speed of up to 10Gbps, allowing you to do more transferring in less time. This usb adapter fits both USB A and USB C charger, supporting up to 3A fast charging
  • Upgraded Exquisite Craftsmanship: With an aluminum alloy housing and metal connector, the usbc to usb adapter is extremely durable and sturdy. Rigorously tested to withstand more than 10,000 times of plugging and unplugging, ensuring long-lasting performance
  • Broad Compatible: The usb c to usb adapter widely supports all USB C/ USB A devices like laptops, tablets, cellphones, car chargers, and phone chargers. Such as compatible with MacBook Pro/Air 2023/2022, Thunderbolt 4/3 Devices,Apple MagSafe Watch 9/8/7/SE/Ultra, iPad Pro 2022/2021, Samsung Galaxy S23/S20/S10, and iPhone 17/16/15 Pro. Plug and play
  • Please Note: To reach 10Gbps speed, keep the cable under 3.3 ft. For USB A Male to USB C adapters, try flipping the USB C connector. USB C Male to USB A adapters support bidirectional 10Gbps transfer within 3.3 ft
Independent reader supportYour contribution helps us test, update, and keep practical guides available for everyone.Support on Ko-Fi

Troubleshooting failures

No screenshots found or comparison has no current images

  • Confirm the capture command actually ran and returned successfully before npx reg-suit run.
  • Check that it wrote image files to the exact directory named by core.actualDir; paths are resolved relative to the job’s working context.
  • Inspect the workflow workspace after capture, and verify the capture script did not write files to a different output directory or skip pages because the app was unavailable.

The wrong baseline is selected

  • Check that the chosen key generator matches your desired baseline behavior.
  • For the Git-hash generator, ensure the checkout includes enough history and that the relevant branch context is available.
  • If the job is detached and the expected branch name is absent, consider the documented branch-name workaround and validate it for the workflow event in use.

Publishing fails

Reg-suit publishers require their own plugin configuration and access setup. Check the selected plugin’s configuration, the credentials and permissions available to the job, and the plugin’s own documentation. The exact credential names and setup differ by publisher, so do not assume an S3 configuration applies to GCS or vice versa.

Artifacts or reports disappear

For reg-actions, confirm the artifact retention setting and repository policy; the project’s documented default is 30 days. For externally published Reg-suit reports, check the storage lifecycle and access configuration you control.

Or skip the browser setup

If you need a screenshot endpoint for a separate capture flow, ScreenshotNeo can return an image or PDF from one GET request. It is separate from Reg-suit: use the resulting image files as inputs to your visual comparison pipeline. For example, this cURL request saves a WebP capture:

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.
Best Value
Anker USB C Hub, 5-in-1 USBC to HDMI Splitter with 4K Display
  • 5-in-1 Connectivity: Equipped with a 4K HDMI port, a 5 Gbps USB-C data port, two 5 Gbps USB-A ports, and a USB C 100W PD-IN port. Note: The USB C 100W PD-IN port supports only charging and does not support data transfer devices such as headphones or speakers.
  • Powerful Pass-Through Charging: Supports up to 85W pass-through charging so you can power up your laptop while you use the hub. Note: Pass-through charging requires a charger (not included). Note: To achieve full power for iPad, we recommend using a 45W wall charger.
  • Transfer Files in Seconds: Move files to and from your laptop at speeds of up to 5 Gbps via the USB-C and USB-A data ports. Note: The USB C 5Gbps Data port does not support video output.
  • HD Display: Connect to the HDMI port to stream or mirror content to an external monitor in resolutions of up to 4K@30Hz. Note: The USB-C ports do not support video output.
  • What You Get: Anker 332 USB-C Hub (5-in-1), welcome guide, our worry-free 18-month warranty, and friendly customer service.
curl -G "https://api.screenshotneo.com/v1/shot" -d access_key=YOUR_API_KEY --data-urlencode url=https://stripe.com -o shot.webp

See the ScreenshotNeo API documentation for request options. ScreenshotNeo accepts cookie/consent banners and removes more than 60 known consent platforms, newsletter popups, and chat widgets before capture; each of those steps can be turned off. Bot checks, blank pages, timeouts, failed loads, and cache hits are not billed, and response headers identify the page verdict and billing status. Its MCP server provides screenshot tools for AI agents, and the free plan includes 1,000 screenshots per month with no card; paid plans start at $5 for 3,000 shots. Sign up free for 1,000 screenshots a month, with no card required.

Frequently Asked Questions

Does reg-actions capture screenshots for me?

No. It uploads and compares images generated earlier in your workflow.

Can Reg-suit publish reports without a cloud publisher?

Its documented publisher plugins include S3 and GCS; the available publication path depends on the plugins you configure.

Product prices and availability are accurate as of the date/time indicated and are subject to change. Any price and availability information displayed on Amazon at the time of purchase will apply.

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.