Skip to content

Official GitHub Action to run Liquibase Calculate Checksum

Notifications You must be signed in to change notification settings

liquibase-github-actions/calculate-checksum

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 Calculate Checksum Action

Official GitHub Action to run Liquibase Calculate Checksum in your GitHub Action Workflow. For more information on how calculate checksum works visit the Official Liquibase Documentation.

Calculate Checksum

Calculates and prints a checksum for the changeset

Usage

steps:
- uses: actions/checkout@v3
- uses: liquibase-github-actions/calculate-checksum@v4.30.0
  with:
    # The root changelog file
    # string
    # Required
    changelogFile: ""

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

    # ChangeSet Author attribute
    # string
    # Optional
    changesetAuthor: ""

    # ChangeSet ID attribute
    # string
    # Optional
    changesetId: ""

    # ChangeSet identifier of form filepath::id::author
    # string
    # Optional
    changesetIdentifier: ""

    # Changelog path in which the changeSet is included
    # string
    # Optional
    changesetPath: ""

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

    # 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 calculate checksum 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/calculate-checksum@v4.30.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.