Flyway Database Migrations Doesn't Support State-Based Deployments

[chrishager82]

Step template

Flyway Database Migrations

Step version

15

Octopus version

2025.4.4847

Step template parameter inputs

No response

What happened

We're working on integrating Flyway into our CI/CD deployment processes to replace SQL Automation. We're exploring the state-based change and deploy option, but encountering some roadblocks.
We found the Octopus Step Template for Flyway Migration is outdated on the following:

1. State-based Deployments
2. Primarily the inclusion of the ‘Prepare’ and ‘Deploy’ commands which are needed for actual deployment and any of their required parameters
3. Change Reports with Check Changes command
4. Generating report based upon snapshots
5. The default check changes always runs with the -dryrun flag which we're not sure if that overrides comparing snapshots
6. Parameters to supply the snapshots should be added to the Step Template. The workaround is to add it to the ‘additional parameters’
7. The reports generated are as if the build database is empty. Even if the build database has the flyway schema history and all the tables of the target database already, the report will show all tables to be ‘Added’ instead of the new migration scripts that are to be applied. This
8. Buildurl is being deprecated. There should be a buildEnvironment added to help with the transition.

Reproduction steps

Configure the step template using existing options and parameters; Prepare and Deploy are not available in the 'Flyway Command' field.

More Information

We opened a case with Red Gate first (340726), they advised us to log an issue with the step template.

[twerthi]

We're currently working with Redgate on this, we have template created that they are testing to make sure it works as desired.

[chrishager82]

Are there any updates? The Red Gate support person working my ticket on their side wasn't aware of any collaborative testing.

[twerthi]

Yes, there has been progress, however, it's a little slow due to time zones. I'm West Coast and they're in England, so our overlap isn't the greatest. The template is in their hands for testing. You could have your support person contact me and I'll direct them to the person I've been working with regarding this.

[twerthi]

I have a beta version if you wanted to give it a go :P

[twerthi]

Just heard from Redgate this morning, they are happy with how the template works. I will get it submitted today.

[chrishager82]

We appreciate your efforts!

[twerthi]

https://library.octopus.com/step-templates/67a28755-049e-4cec-b45c-3e5047350d8d/actiontemplate-flyway-state-based-migration