Flyway Pipeline Reports
Published 27 September 2024
Flyway reports just got even better in conjunction with Flyway Pipelines. All of the Flyway reports can now be stored in a central location and will provide you with a comprehensive audit trail of all of the reports which have been run against a specific environment and pipeline.
Flyway reports have been designed to act as a pre deployment check to
- Mitigate the risk of a deployment failure or data loss
- Improve Auditability and Compliance by providing a user friendly view of what changes are being made pre and post deployment
- Improves Visibility and Communication as everyone in your team or organization can view the report prior to a deployment being approved.
Now all of your Flyway reports can be accessed within the Flyway Pipelines to give you a comprehensive audit trail of your deployment history. If Flyway Pipelines are new to you, take a look at Flyway Pipelines here
Which Edition of Flyway are the reports available in
Report | Flyway Community | Flyway Teams | Flyway Enterprise |
---|---|---|---|
Flyway Info | Yes | Yes | Yes |
Flyway Migrate | Yes | Yes | Yes |
Check -Code | Yes | Yes | Yes |
Check -Dryrun | Not available | Yes | Yes |
Check -Drift | Not available | Not available | Yes |
Check -Changes | Not available | Not available | Yes |
How to see the reports in Flyway Pipelines
Within a specific pipeline, click on the environment you want to see a deployment history for
The deployment history will appear and if any reports have been run, they will appear in the list each with a unique ID. To view the report click on the open report link
The report below is an example info report.
How to Configure the reports
Once you have enabled Flyway Pipelines, instructions on how to do this can be found here.
To enable the reports add the following parameters onto your Flyway Commands.
- -flywayServicePublish.publishReport=true
- -reportEnabled=true
The reports can be used with Info, Migrate and Check, examples of which are provided below: -
- flyway check -changes -drift -code -dryrun -environment=build -publishResult=true -flywayServicePublish.publishReport=true -reportEnabled=true
- flyway info -environment=build -publishResult=true -flywayServicePublish.publishReport=true -reportEnabled=true
- Flyway migrate -environment=build -publishResult=true -flywayServicePublish.publishReport=true -reportEnabled=true
Examples of these reports can all be seen here.
Setting up the changes and Drift report
If the check command is new to you the following resources will give you all of the information you need to get started