Skip to main content
Swagger
All documentation pages

Migrating from Swagger Contract Testing On-Premises 1.x

Swagger Contract Testing On-Premises 1.x.x is now deprecated and no longer supported as of March 11, 2026. This version no longer receives updates, including security updates. We recommend upgrading to a supported version 2.x as soon as possible.

This major release introduces significant architectural changes and new features:

  • A redesigned user interface.

  • A switch from Alpine to an Ubuntu Linux base image for improved compatibility and security posture.

  • Internal architecture updates, including the use of HAProxy for traffic routing and supervisord for process management.

  • New caching and session management layers, requiring a Redis Serialization Protocol (RESP)-compatible key/value storage engine.

Migration notes

The 2.x release line remains largely compatible with 1.x. To install and run it, you must make the following changes:

  1. Use a Redis-compatible data store (such as Redis or Valkey). Ensure you set the REDIS_URL environment variable.

  2. Set the PACTFLOW_COOKIE_SECRET environment variable to a value that is at least 64 characters. Read more in Environment Variables.

  3. Do not use the PACTFLOW_LOG_FORMAT environment variable. It is deprecated and has no effect. All logs now output in JSON format only.

  4. If you customized the image, review your setup and update any installed tools or libraries accordingly. It is because we changed the base image from Alpine Linux to Ubuntu 24.04.

This release does not require any database or data migrations. You can upgrade or roll back between 1.x and 2.x without database compatibility issues. All existing API calls, SDKs, and CLI integrations continue to work.

Compatibility Matrix for On-prem 1.x and 2.x

Not all 2.x versions support direct upgrades from every 1.x version.

Before you upgrade, check the compatibility table below to confirm that your current 1.x version supports a direct upgrade to your target 2.x version.

Table 14. Supported Direct Upgrades

Current Version (1.x) Supported Upgrade To (2.x)
1.37.0 2.0.0 or later
1.37.1 2.1.1 or later
1.37.2 2.2.0 or later
1.37.3 2.4.0 or later

Migration checklist

Use the following checklist to prepare for the upgrade from Swagger Contract Testing On-Premises 1.x to 2.x.

  • Provision a Redis-compatible data store (Redis or Valkey).

  • Set the REDIS_URL environment variable.

  • Ensure PACTFLOW_COOKIE_SECRET is at least 64 characters long.

  • Update your environment configuration if required.

  • Remove any usage of the PACTFLOW_LOG_FORMAT environment variable.

  • Update monitoring and forwarding pipelines to expect JSON logs only.

  • Note that the base image has changed from Alpine Linux to Ubuntu 24.04.

  • If you maintain a custom image, review and update any tools, libraries, or scripts.

Was this page helpful?