Using the Checks Settings Configuration File

Another part of the Liquibase quality checks configuration is the checks settings file named as liquibase.check-settings.conf by default.

The checks settings file includes your configuration of checks, which you can use for a specific project or share across a team or organization. You may have multiple checks settings configuration files and store them in source code control or artifact repository for versioning, consistent use, and automation.

In Liquibase 4.5, the checks settings file is encoded, while Liquibase 4.6.0 and later versions provide unencoded checks settings files. An unencoded file is easier to inspect and resolve merge conflicts when using SCM.

Creating and modifying the checks settings file

When you start using the quality checks functionality by running any checks command, Liquibase identifies the need for a checks settings file:

  • To create the default checks settings file named liquibase.check-settings.conf in the Liquibase working directory, enter Y at runtime.
  • To use the in-memory file while running run or show, enter N at runtime. Other subcommands require a checks settings file to save the changes for checks.
  • To use a checks settings file customized for a specific environment or project, pass it with the checks settings file parameter. If you do not include the parameter, Liquibase uses the in-memory file or default settings file – liquibase.checks-settings.conf.

Warning: Do not modify the checks settings file directly because it may cause unrecoverable and unsupported errors.

Automatic update of checks settings file 4.5.0 with the use of Liquibase 4.6.0 and later versions

When you use an encoded checks settings file from Liquibase 4.5.0 with Liquibase 4.6.0 or later versions, Liquibase will automatically back up your checks settings file as liquibase.checks-settings.conf.v4.5 and update it.

In most cases, you do not need to take any action. However, when you work in an environment in which a Liquibase 4.5.0 user cannot upgrade to version 4.6.0 and must use the same shared check settings file, the Liquibase 4.5.0 user needs to specify the compliant checks settings file 4.5.0 by using --checks-settings-file=<mybackedupfile.conf.v4.5>.

The following examples use the default name of the checks settings file, but the same is true for any specified checks settings file:

  • If you use Liquibase 4.5.0, you will have the encoded liquibase.checks-settings.conf file and it will remain encoded so long as you use version 4.5.0.
  • If you have Liquibase 4.6.0 or later versions when you start using quality checks, your first liquibase.checks-settings.conf file will be unencoded by default.
  • If you have Liquibase 4.6.0 or later versions and use an encoded checks settings file 4.5.0, it will be backed up and unencoded automatically.

Related links