Configure Policy Checks

Configuring policy checks is file-based and stored in a standard default YAML file named liquibase.checks-settings.conf. Users can store the file in a centralized repository or another storage solution, providing teams and automation jobs with a single consistent source to validate changes.

A checks file is provided as a sample for teams looking to get started. This document defines the checks that have been enabled in the sample file.

Procedure

To build your own liquibase.checks-settings.conf file, run the liquibase checks show command in your local repository. This command will prompt for information regarding the location of the checks file.
Type 1 to create the checks file in the root directory:

This image depicts running the "liquibase checks show" command to generate a new liquibase.checks-settings.conf. The command begins an interactive session and provides additional options for creation of the settings file.

The default checks associated with your Liquibase version will be displayed in the console:

This image depicts the output when exiting the "liquibase checks show" command. The command outputs each check and its settings associated with the configuration.

Enable or disable checks:

liquibase checks enable --check-name=<check_short_name>

liquibase checks disable --check-name=<check_short_name>

Change the severity level

liquibase checks customize --check-name=<check_short_name>

See Setting policy checks' severity and exit code for the list of the severity levels and return codes.

Create a new check using a regex pattern

liquibase checks copy --check-name=SqlUserDefinedPatternCheck

What to do next

Run Policy Checks

Page updated

Report abuse