status's Introduction

Liquibase Status Action

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

Status

Generate a list of pending changesets

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: ""

    # Changeset contexts to match
    # string
    # Optional
    contexts: ""

    # 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: ""

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

    # Verbose flag with optional values of "True" or "False". The default is "True".
    # bool
    # Optional
    verbose: ""

Secrets

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

Optional Liquibase Global Inputs

The liquibase status 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