Skip to content

Official GitHub Action to run Liquibase Future Rollback Sql

Notifications You must be signed in to change notification settings

liquibase-github-actions/future-rollback-sql

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

Liquibase Future Rollback Sql Action

Official GitHub Action to run Liquibase Future Rollback Sql in your GitHub Action Workflow. For more information on how future rollback sql works visit the Official Liquibase Documentation.

Future Rollback Sql

Generate the raw SQL needed to rollback undeployed changes

Usage

steps:
- uses: actions/checkout@v3
- uses: liquibase-github-actions/future-rollback-sql@v4.28.0
  with:
    # The root changelog file
    # string
    # Required
    changelogFile: ""

    # The JDBC database connection URL
    # string
    # Required
    url: ""

    # Fully-qualified class which specifies a ChangeExecListener
    # string
    # Optional
    changeExecListenerClass: ""

    # Path to a properties file for the ChangeExecListenerClass
    # string
    # Optional
    changeExecListenerPropertiesFile: ""

    # Context string to use for filtering
    # string
    # Optional
    contextFilter: ""

    # The default catalog name to use for the database connection
    # string
    # Optional
    defaultCatalogName: ""

    # The default schema name to use for the database connection
    # string
    # Optional
    defaultSchemaName: ""

    # The JDBC driver class
    # string
    # Optional
    driver: ""

    # The JDBC driver properties file
    # string
    # Optional
    driverPropertiesFile: ""

    # Label expression to use for filtering
    # string
    # Optional
    labelFilter: ""

    # Control whether names of objects in the default catalog are fully qualified or not. If true they are. If false, only objects outside the default catalog are fully qualified
    # bool
    # Optional
    outputDefaultCatalog: ""

    # Control whether names of objects in the default schema are fully qualified or not. If true they are. If false, only objects outside the default schema are fully qualified
    # bool
    # Optional
    outputDefaultSchema: ""

    # Password to use to connect to the database
    # string
    # Optional
    password: ""

    # Username to use to connect to the database
    # string
    # Optional
    username: ""

Secrets

It is a good practice to protect your database credentials with GitHub Secrets

Optional Liquibase Global Inputs

The liquibase future rollback sql action accepts all valid liquibase global options as optional parameters. A full list is available in the official Liquibase Documentation.

Example

steps:
  - uses: actions/checkout@v3
  - uses: liquibase-github-actions/future-rollback-sql@v4.28.0
    with:
      changelogFile: ""
      url: ""
      headless: true
      licenseKey: ${{ secrets.LIQUIBASE_LICENSE_KEY }}
      logLevel: INFO

Feedback and Issues

This action is automatically generated. Please submit all feedback and issues with the generator repository.