Skip to content

Official GitHub Action to run Liquibase Rollback One Update

Notifications You must be signed in to change notification settings

liquibase-github-actions/rollback-one-update

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 Rollback One Update Action

Official GitHub Action to run Liquibase Rollback One Update in your GitHub Action Workflow. For more information on how rollback one update works visit the Official Liquibase Documentation.

Rollback One Update

[PRO] Rollback one update from the database

Usage

steps:
- uses: actions/checkout@v3
- uses: liquibase-github-actions/rollback-one-update@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 deployment ID of the update to rollback
    # string
    # Optional
    deploymentId: ""

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

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

    # A required safety flag to indicate you intend to use this feature
    # bool
    # Optional
    force: ""

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

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

    # [PRO] Enable or disable reporting.
    # bool
    # Optional
    reportEnabled: ""

    # [PRO] The name of the report.
    # string
    # Optional
    reportName: ""

    # [PRO] The path to the directory to generate the report.
    # string
    # Optional
    reportPath: ""

    # The path to the script to use to perform the rollback
    # string
    # Optional
    rollbackScript: ""

    # 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 rollback one update 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/rollback-one-update@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.