Setup Flyway

The setup-flyway action will download and set up a requested version of the Flyway CLI.

Usage

• version - The version of Flyway CLI to set up. Can specify latest, an exact version, or a semver version. Default: latest.
• architecture - The hardware architecture version of the Flyway CLI. Can specify x64, arm64, or java. The Java version will require Java 17 or higher to be installed, preferably using actions/setup-java. Default: the architecture of the runner.
• platform - The operating system version of the Flyway CLI. Can specify linux, linux-alpine, macos, or windows. This setting is ignored when java is selected for the architecture. Default: the platform of the runner.
• edition - The edition of the Flyway CLI to set up. Can specify community or enterprise. Default: community.

Note

The Flyway CLI supports windows-x64, linux-x64, macosx-arm64, macosx-x64, and linux-alpine-x64 platforms. For all other platforms, the Java version of the Flyway CLI should be used.

Basic Configuration

Typical setup

- uses: red-gate/setup-flyway@v1

Java version

- uses: actions/setup-java@v4
  with:
    distribution: 'zulu' # See 'Supported distributions' for available options
    java-version: '21'
- uses: red-gate/setup-flyway@v1
  with:
    architecture: 'java'

Supported version syntax

The version input supports an exact version or a version range using SemVer notation:

• major versions: 9, 10
• more specific versions: 10.11, 10.12.0, 10.13.x
• the current version: latest

License

The scripts and documentation in this project are released under the MIT License.

Contributions

Contributions are welcome! See Contributor's Guide

Security Policy

Find a security issue? Please review our Security Policy.

Support

For support, please see the Support Policy.