im-open/Run Flyway Command
Runs the flyway command line tool against the given database
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Activelast commit May 8, 2026
- License
- MIT
Pinned Snippet
uses: im-open/run-flyway-command@a498fe67ce69a973484c9339edb557bcfe87c810 # v1.5.1tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| db-server-name | The database server name. | yes | — |
| db-server-port | The port the database server listens on. | no | 1433 |
| db-name | The name of the database to run flyway against. | yes | — |
| trust-server-certificate | A boolean that controls whether or not to validate the SQL Server TLS certificate. | no | false |
| migration-files-path | The path to the base directory containing the migration files to process with /src/run-flyway.ps1 | yes | — |
| flyway-command | The flyway command to run; e.g migrate, validate, etc. | yes | — |
| migration-history-table | The table where the migration history lives. This is most likely dbo.MigrationHistory or Flyway.MigrationHistory. | yes | — |
| baseline-version | The baseline version to send to the flyway command. | no | 0 |
| managed-schemas | A comma separated list of schemas that are to be managed by Flyway.MigrationHistory. | yes | — |
| enable-out-of-order | A switch that allows new migrations that are a lower version number than a current migration to be run. | no | false |
| validate-migrations | A switch determining whether flyway should validate the migration scripts before running them. | no | true |
| use-integrated-security | A switch defining whether or not to use integrated security. If not provided, a password should be. | no | false |
| use-azure-service-principal | A switch to indicate that an Azure Active Directory Service Principal will be used to authenticate with the SQL Server. | no | false |
| use-azure-default-credential | A switch to indicate that an Azure Active Directory Credential will be used to authenticate with the SQL Server. This credential includes any credential in the Azure Identity Provider | no | false |
| username | The username of the user making the changes, which is put into the MigrationHistory table, and also to login with if not using integrated security. This should be the Service Principal ID if use-azure-service-principal is set to true. | no | — |
| password | The password for the user making changes if not using integrated security. This should be the Service Principal Secret if use-azure-service-principal is set to true. | no | — |
| extra-parameters | A string containing anything extra that should be added to the flyway command. | no | — |
Outputs
no outputs