Use the checks package file

Last updated: November 18, 2025

Once you've created your checks package file, you can use it with the checks show and checks run commands. Specify the name of your file with --checks-settings-file and the name of your package object(s) with --checks-packages.

Note: If the checks package file is named liquibase.checks-settings.conf, you do not need to specify the file name in --checks-settings-file. However, if you use a custom name for your package file, you must specify it.

Procedure

1

Show a list of checks associated with your package

liquibase checks show --checks-settings-file=liquibase.security-checks.yaml --checks-packages=platform-checks
2

Run all checks in your package

liquibase checks run --checks-settings-file=liquibase.security-checks.yaml --checks-packages=platform-checks
3

Specify multiple specific checks packages in your package file with a comma-separated list

liquibase checks run --checks-settings-file=liquibase.security-checks.yaml --checks-packages=platform-checks,qa-checks
4

Run all checks packages in your package file by omitting the --checks-packages parameter

liquibase checks run --checks-settings-file=liquibase.security-checks.yaml

Results

The checks show output table contains a column that displays the source checks settings file of each check. There is also a line in the output of checks run that highlights the checks settings file which holds the enabled checks. For more information, see Use the Checks Settings Configuration File.

Checks Packages File Example

This is an example of a checks package file containing multiple packages for different purposes:

checksPackages: ## packages by pipeline node - name: "dev-checks-files" files: - "./liquibase.checks-settings.conf" - "./liquibase.dev-checks.yaml" - name: "uat-checks-files" files: - "./liquibase.checks-settings.conf" - "./liquibase.uat-checks.yaml" - name: "prod-checks-files" files: - "./liquibase.checks-settings.conf" - "./liquibase.prod-checks.yaml" - "./liquibase.prod-checks-v2.yaml" ## packages by appteam - name: "appteam1-files" files: - "s3://allteams/liquibase.checks-settings.conf" - "s3://allteams/liquibase.securityrelease.conf" - "./liquibase.appteam1.us-dev.yaml" - name: "appteam2-files" files: - "s3://allteams/liquibase.checks-settings.conf" - "s3://allteams/liquibase.securityrelease.conf" - "./liquibase.appteam2.us-dev.yaml" ## packages by db platform - name: "oracle" files: - "./platformchecks/liquibase.checks-oracle.yaml" - name: "postgres" files: - "./platformchecks/liquibase.checks-postgres.yaml" - "./platformchecks/liquibase.checks-postgres-older-versions.yaml" - name: "sqlserver" files: - "./platformchecks/liquibase.checks-sqlserver.yaml"