October DealsAmazon USOctober deal check: compare before you payAmazon US: current deals, useful picks and tech finds.Check DealsClean PCRecommendedOne scan can reveal what keeps slowing WindowsLook for cleanup and repair opportunities.Run ScanOctober DealsAmazon USDeal season is back - check today's better picksAmazon US: current deals, useful picks and tech finds.See Picks×
Skip to content
World desk6 min

How to Run Happo Screenshot Tests in GitLab CI

Happo’s experimental GitLab integration can report merge-request statuses and find visual baselines. Here’s how to connect it, add a CI job, and test the edge cases.
Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.

Happo’s GitLab integration can report visual-test status on merge requests, find baselines by walking commit history, and cancel superseded jobs. It was announced on September 10, 2026, and is experimental. The practical setup combines a Happo project connection with a GitLab CI job that installs your project and runs the happo CLI; verify the current GitLab-specific instructions in Happo’s connection flow rather than assuming a generic YAML example is complete.

What the GitLab integration does—and what remains experimental

Happo announced GitLab support on September 10, 2026. The integration is designed to post merge-request status checks, locate visual baselines by walking commit history, and cancel jobs superseded by newer work. Happo labels the integration experimental, so validate its behavior with your repository before relying on it as a required merge gate. Happo’s announcement

As an Amazon Associate I earn from qualifying purchases.

The announcement says self-managed GitLab is supported, but network allowlisting may be needed. It also calls out unusual branch names, fork-based merge requests, retargeted merge requests, self-managed network configurations, and CI concurrency as scenarios that may need real-world testing. Treat those as explicit test cases if they apply to your project.

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

Connect the GitLab project to Happo

  1. Open Happo’s GitLab connection flow and follow the fields it presents. The announcement lists a GitLab project ID, access token, instance URL, and webhook signing token as connection details.

    #1 Best Overall
    Philips 24 Inch Computer Monitor FHD 100Hz VA VESA Flicker-Free, 241V8LB
    • CRISP CLARITY: This 23.8″ Philips V line monitor delivers crisp Full HD 1920x1080 visuals. Enjoy movies, shows and videos with remarkable detail
    • INCREDIBLE CONTRAST: The VA panel produces brighter whites and deeper blacks. You get true-to-life images and more gradients with 16.7 million colors
    • THE PERFECT VIEW: The 178/178 degree extra wide viewing angle prevents the shifting of colors when viewed from an offset angle, so you always get consistent colors
    • WORK SEAMLESSLY: This sleek monitor is virtually bezel-free on three sides, so the screen looks even bigger for the viewer. This minimalistic design also allows for seamless multi-monitor setups that enhance your workflow and boost productivity
    • A BETTER READING EXPERIENCE: For busy office workers, EasyRead mode provides a more paper-like experience for when viewing lengthy documents
  2. Confirm the current access-token scopes in Happo’s live form or linked instructions. The announcement does not specify scopes, so do not infer permissions or create a broader token than the current setup requires.

  3. Store the Happo API key and API secret as GitLab CI/CD variables. Keep them out of committed files and logs; the Happo configuration should read them from environment variables.

  4. If you use self-managed GitLab, verify that the Happo service and your CI runners can reach the required GitLab and application endpoints. Network allowlisting requirements depend on your deployment.

    What’s actually slowing this PC down?

    Pick the symptom - the matching free tool is one click away.

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

Install the Happo CLI and add a project configuration

Install the current happo package as a development dependency, using the package manager already used by the repository. The Happo repository documents these options: Happo on GitHub.

  • npm install --save-dev happo
  • pnpm add --save-dev happo
  • yarn add --dev happo

Add a Happo configuration at the repository root. The README recognizes configuration filenames including happo.config.js, happo.config.mjs, happo.config.cjs, happo.config.ts, happo.config.mts, and happo.config.cts. A representative configuration shape is:

Rank #2
Philips 22 Inch Computer Monitor FHD 100Hz VA VESA Flicker-Free, 221V8LB
  • CRISP CLARITY: This 22 inch class (21.5″ viewable) Philips V line monitor delivers crisp Full HD 1920x1080 visuals. Enjoy movies, shows and videos with remarkable detail
  • 100HZ FAST REFRESH RATE: 100Hz brings your favorite movies and video games to life. Stream, binge, and play effortlessly
  • SMOOTH ACTION WITH ADAPTIVE-SYNC: Adaptive-Sync technology ensures fluid action sequences and rapid response time. Every frame will be rendered smoothly with crystal clarity and without stutter
  • INCREDIBLE CONTRAST: The VA panel produces brighter whites and deeper blacks. You get true-to-life images and more gradients with 16.7 million colors
  • THE PERFECT VIEW: The 178/178 degree extra wide viewing angle prevents the shifting of colors when viewed from an offset angle, so you always get consistent colors
module.exports = {
  apiKey: process.env.HAPPO_API_KEY,
  apiSecret: process.env.HAPPO_API_SECRET,
  targets: [
    { name: "chrome", browser: "chrome" },
    { name: "firefox", browser: "firefox" },
    { name: "ios-safari", browser: "ios-safari" }
  ]
};

Use the target and configuration options supported by the version you install; the example illustrates environment-based credentials and browser targets, not a complete app-specific configuration. Provide whatever local app or Storybook URL your project’s Happo setup needs.

Add a GitLab CI job

GitLab reads pipeline jobs from .gitlab-ci.yml. The following is only an illustrative pipeline shape, not an official, complete Happo GitLab recipe:

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.
happo:
  stage: test
  script:
    - npm ci
    - npx happo

Adapt the install command, runner image, stage, caching, and any application or Storybook startup to your repository. Ensure the server is ready before Happo captures pages. Configure the Happo API credentials as protected or otherwise appropriately scoped CI/CD variables, according to which branches and merge requests need to run the job.

Happo’s general CI documentation describes a unified CLI workflow and generic-CI arguments --beforeSha, --afterSha, and --link. The accessible documentation does not provide a complete GitLab-specific YAML example, although the announcement directs users to a GitLab-specific section. Confirm in the current project connection flow whether the integration supplies commit SHAs and the merge-request or commit link automatically. Do not add guessed arguments as though they were Happo’s official GitLab command. Happo CI documentation

Run visual checks on the default branch as well as merge-request changes so the system has a baseline to compare against. Confirm the integration’s branch and baseline behavior in your own project; experimental GitLab handling may differ from other providers.

Rank #3
Sale
Dell 24 Monitor - SE2426H - 23.8-inch FHD (1920x1080) 144Hz 1ms Display, in-Plane Switching (IPS) Technology, AMD FreeSync™, TÜV 3-Star 2X HDMI, Tilt
  • Clear visuals. Fluid motion: A 144Hz refresh rate and 1ms MPRT deliver smooth, tear‑free motion across work, gaming, and streaming for clearer, more fluid viewing.
  • Eye comfort: TÜV Rheinland 3‑star* certification reduces harmful blue light while preserving stunning color quality without compromise. *TÜV Rheinland 3-star eye comfort certification.
  • Wide viewing angle: Get consistent views across a wide 178° /178° viewing angle.
  • In-Plane Switching (IPS): See excellent color accuracy and consistency across wide viewing angles with In-plane Switching (IPS) technology.
  • Ultra-thin bezels: Maximize your viewing experience with thin bezels.

Validate the pipeline and merge-request reporting

  1. Validate .gitlab-ci.yml with GitLab’s CI Lint before committing pipeline changes. GitLab CI Lint

    Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.
  2. Run the job on the default branch and check that Happo receives a successful capture and establishes the expected baseline.

  3. Open a merge request that changes a captured component. Check that the Happo result appears as a merge-request status and that the intended baseline was selected.

  4. Push a second commit while a capture is running and verify the superseded-job behavior. Also test forks, unusual branch names, and retargeted merge requests where relevant.

  5. For self-managed GitLab, repeat the checks from the actual network environment and resolve any allowlisting or reachability issues.

    Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.
    Rank #4
    Sale
    Samsung 27" Essential S3 (S36GD) Series FHD 1800R Curved Computer Monitor | 100Hz, Game Mode, Advanced Eye Comfort, HDMI and D-sub Ports (LS27D366GANXZA)
    • CURVED FOR ENHANCED ENGAGEMENT: An immersive viewing experience with a curved monitor that wraps more closely around your field of vision; It creates a wider view, enhancing depth perception and minimizing peripheral distraction
    • SMOOTH PERFORMANCE FOR SEAMLESS CONTENT: Stay in the action when playing games, watching videos, or working on creative projects; The 100Hz refresh rate reduces lag and motion blur so you don't miss a thing in fast-paced moments¹
    • MORE GAMING POWER: Gain the edge with optimizable game settings; Color and image contrast can be adjusted to see scenes more vividly and spot enemies hiding in the dark; Game Mode adjusts any game to fill the screen so you can view every detail²
    • KEEP IT EASY ON THE EYES: Care for your eyes and stay comfortable, even during long sessions; Advanced eye comfort technology certified by TÜV reduces eye strain by minimizing blue light and reducing irritating screen flicker²
    • INCREASED VERSATILITY: Connect to more; Plug devices straight into your monitor for increased flexibility, making your computing environment even more convenient

Happo visual diffs are not GitLab JUnit reports

Happo’s integration connects visual comparisons to merge-request status checks. GitLab’s JUnit test-report feature is a separate mechanism for showing test results and, optionally, screenshots in test details. A JUnit screenshot attachment is not a Happo visual diff. In addition, emitting a JUnit report does not itself make a job fail; the test script must exit nonzero when a failure should fail the pipeline. Use JUnit artifacts only if you also want GitLab-native test diagnostics. GitLab unit test reports

Independent reader supportYour contribution helps us test, update, and keep practical guides available for everyone.Support on Ko-Fi

Troubleshooting

  • No Happo merge-request status appears: Recheck the GitLab connection details, webhook signing token, project ID, and that the job ran for the merge request. Verify the live integration instructions and token permissions; the launch announcement does not publish required token scopes.

  • Happo cannot authenticate: Confirm the CI variables contain the API key and secret expected by your config, are available to that pipeline’s branch or merge-request context, and are not being shadowed by empty variables.

  • Captures fail or show an unavailable page: Start the application or Storybook before invoking Happo, wait until it is ready, and confirm the runner can reach the target URL. In self-managed setups, check network access and allowlisting.

    Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.
  • Baselines are missing or unexpected: Run the job on the default branch and inspect the project’s branch history and merge-request target. Confirm baseline lookup in a straightforward merge request before testing forks, retargeting, or nonstandard branch patterns.

    Best Value
    Sale
    Sceptre New 22-Inch Gaming Monitor, FHD 1080p, Up to 144Hz, HDMI, DisplayPort, Built-in Speakers, Machine Black (E225W-FW144 Series, 2026)
    • 【INTEGRATED SPEAKERS】Whether you're at work or in the midst of an intense gaming session, our built-in speakers provide rich and seamless audio, all while keeping your desk clutter-free.
    • 【EASY ON THE EYES】 Protect your eyes and enhance your comfort with Blue-Light Shift technology. This feature reduces harmful blue light emissions from your screen, helping to alleviate eye strain during long hours of use and promoting healthier viewing habits.
    • 【WIDEN YOUR PERSPECTIVE】Our sleek minimal bezel design ensures undivided attention. The nearly bezel-free display seamlessly connects in a dual monitor arrangement, delivering an unobstructed view that lets you focus on more at once, completely distraction-free.
  • Old work continues after a newer commit: Check concurrency and cancellation behavior with real pipeline runs. Happo says it can cancel superseded jobs, but its integration is experimental and concurrency is among the cases flagged for validation.

  • GitLab reports a YAML error: Use CI Lint to locate invalid syntax, then check indentation and whether your job uses a stage defined in the pipeline.

Or skip the browser setup

If your goal is to capture clean website screenshots from code rather than run Happo visual-regression comparisons, ScreenshotNeo provides a screenshot API and MCP server. It accepts a URL in one GET request and can return PNG, JPEG, WebP, or PDF. For example, use cURL like this; see the ScreenshotNeo API documentation for parameters and response details:

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.
curl -G "https://api.screenshotneo.com/v1/shot" -d access_key=YOUR_API_KEY --data-urlencode url=https://stripe.com -o shot.webp

ScreenshotNeo accepts cookie or consent banners before capture and removes more than 60 known consent platforms, newsletter popups, and chat widgets; each step can be turned off. Bot checks, blank pages, timeouts, failed loads, and cache hits are not billed, with response headers identifying the page verdict and billing status. Its MCP server offers screenshot and page-info tools for AI agents. The free plan includes 1,000 screenshots per month with no card; paid plans start at $5 for 3,000. Sign up for ScreenshotNeo’s free plan.

Frequently Asked Questions

Does Happo officially publish a complete GitLab CI YAML example?

The accessible general CI documentation does not show a complete GitLab-specific YAML recipe. Use the current GitLab connection flow and verify the actual project setup rather than treating the abbreviated pipeline shape as official.

Can Happo connect to self-managed GitLab?

Yes. Happo’s September 10, 2026 announcement says self-managed GitLab is supported, and notes that network allowlisting may be necessary.

Can a GitLab JUnit screenshot attachment replace a Happo visual comparison?

No. GitLab JUnit reports and Happo visual diffs are separate features; a JUnit attachment does not provide a Happo comparison.

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

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.

Leave a Reply

Your email address will not be published. Required fields are marked *

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

More from the Wire

  1. World desk4 min
    How to Spot an AI Voice Scam Before Sending MoneyDon’t rely on how a caller sounds. Pause, call back through a known number, and verify the emergency with another trusted person before sending money.
  2. Mountain View desk4 min
    Google’s SynthID Detector: How to Check AI-Generated Images, Video and AudioGoogle’s SynthID Detector looks for an embedded watermark in supported images, video and audio. Here is what its results do—and do not—show.
  3. Redmond desk20 min
    How to create a link to File or Folder in Windows 11Windows 11 gives you several ways to point to a file or folder without moving or duplicating it. You can create a desktop shortcut,…
Recommended PC Tool
Recommended PC Tool
PC Slower Than It Used to Be?Free scan - under a minute
Crashes, No Sound, or Screen Glitches?Free driver scan

Two free Windows tools

One Free Minute Could Fix That PC

Before you go - each of these free tools takes about a minute and tackles what quietly slows a Windows PC down.

Special offer. View Outbyte info, uninstall instructions, EULA, and Privacy Policy.