Secure 5.1: Create a checks package file

Create a checks package file

Last updated: November 18, 2025

If you don't yet have any checks settings files, follow each of these steps starting at Step 1.

If you already have a collection of related checks settings files, skip directly to Step 4 to put them into a package.

Before you begin

Create a checks settings file before you create a checks package file.

Procedure

Run the checks create command to create a new YAML checks package file

For--package-file, specify any file name ending with .yaml. If you specify a file that does not exist, Liquibase will create it.
For --package-name, specify any descriptive name for a package object to be listed in the file.
For --package-contents, specify all the settings files you just created. If you specify a directory, all files within the directory will be added to the --package-name object, but not recursively.

Unix example

liquibase checks create \
  --package-file=liquibase.security-checks.yaml \
  --package-name=platform-checks \
  --package-contents=oracle-checks.yaml,postgres-checks.yaml,sqlserver-checks.yaml

Windows example

liquibase checks create ^
  --package-file=liquibase.security-checks.yaml ^
  --package-name=platform-checks ^
  --package-contents=oracle-checks.yaml,postgres-checks.yaml,sqlserver-checks.yaml

This creates a package file called liquibase.security-checks.yaml. The file contains one package object (platform-checks), which contains three checks settings files for different databases:

checksPackages: - name: platform-checks files: - oracle-checks.yaml - postgres-checks.yaml - sqlserver-checks.yaml

Results

Now you've successfully created a checks package file!

Repeat these steps for as many settings files and packages you want to create.

You can reuse check settings files across multiple packages, or you can keep them all completely separate.
You can also add an additional settings file to an existing package by running checks create again and specifying the settings file and package to add it to.

Note: To remove checks settings files from an existing package object or to remove a package object altogether, you must open your YAML file and make the changes manually.