Liquibase Update Action

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

Update

Deploy any changes in the changelog file that have not been deployed

Usage

steps:
- uses: actions/checkout@v3
- uses: liquibase-github-actions/[email protected]
  with:
    # The root changelog
    # 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: ""

    # Changeset contexts to match
    # 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: ""

    # Changeset labels to match
    # 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: ""

    # [PRO] Setting to prevent the display of exceptions (which might contain SQL) in operation reports. If suppressSql is on, and no value is provided here, it is assumed to also be on.
    # bool
    # Optional
    reportSuppressException: ""

    # [PRO] Setting to prevent the display of changeset SQL in operation reports.
    # bool
    # Optional
    reportSuppressSql: ""

    # If set to true and any changeset in a deployment fails, then the update operation stops, and liquibase attempts to rollback all changesets just deployed. A changeset marked "fail-on-error=false" does not trigger as an error, therefore rollback-on-error will not occur. Additionally, if a changeset is not auto-rollback compliant or does not have a rollback script, then no rollback-on-error will occur for any changeset.
    # bool
    # Optional
    rollbackOnError: ""

    # Type of update results summary to show.  Values can be "off", "summary", or "verbose".
    # string
    # Optional
    showSummary: ""

    # Summary output to report update summary results. Values can be "log", "console", or "all".
    # string
    # Optional
    showSummaryOutput: ""

    # 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 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/[email protected]
    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.