liquibase-github-actions/Liquibase Generate Changelog Action
Generate a changelog
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Maintainedlast commit Aug 6, 2025
- License
- Apache 2.0
Pinned Snippet
uses: liquibase-github-actions/generate-changelog@600fd6b6ca8a25e6aa39aa1a4f9a4d61f34d3fd1 # v4.33.0tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| author | Specifies the author for changesets in the generated changelog | no | — |
| changelogFile | Changelog file to write results | no | — |
| contextFilter | Changeset contexts to generate | no | — |
| dataOutputDirectory | Specifies a directory to send the loadData output of a diff-changelog/generate-changelog command as a CSV file. | no | — |
| defaultCatalogName | The default catalog name to use for the database connection | no | — |
| defaultSchemaName | The default schema name to use for the database connection | no | — |
| diffTypes | Types of objects to compare | no | — |
| driver | The JDBC driver class | no | — |
| driverPropertiesFile | The JDBC driver properties file | no | — |
| excludeObjects | Objects to exclude from diff. Supports regular expressions. Defaults to null. | no | — |
| ignoreMissingReferences | If true, diff operations will ignore referenced objects which are not found in a snapshot. | no | — |
| includeCatalog | If true, the catalog will be included in generated changeSets. Defaults to false. | no | — |
| includeObjects | Objects to include in diff. Supports regular expressions. Defaults to null. | no | — |
| includeSchema | If true, the schema will be included in generated changeSets. Defaults to false. | no | — |
| includeTablespace | Include the tablespace attribute in the changelog. Defaults to false. | no | — |
| labelFilter | Changeset labels to generate | no | — |
| outputSchemas | Output schemas names. This is a CSV list. | no | — |
| overwriteOutputFile | Flag to allow overwriting of output changelog file. Default: false | no | — |
| password | Password to use to connect to the database | no | — |
| replaceIfExistsTypes | Sets replaceIfExists="true" for changes of these types (supported types: createProcedure, createView) | no | — |
| runOnChangeTypes | Sets runOnChange="true" for changesets containing solely changes of these types (e. g. createView, createProcedure, ...). | no | — |
| schemas | Schemas to include in diff | no | — |
| skipObjectSorting | When true will skip object sorting. This can be useful on databases that have a lot of packages/procedures that are linked to each other | no | — |
| url | *required* The JDBC database connection URL | yes | — |
| useOrReplaceOption | If true, will add "OR REPLACE" option to the create view change object | no | — |
| username | Username to use to connect to the database | no | — |
| addEmptyMdcValues | If true, a subset of the MdcKeys, as defined by product, will be set to empty strings upon system startup. | no | — |
| allowDuplicatedChangesetIdentifiers | Allows duplicated changeset identifiers without failing Liquibase execution. | no | — |
| alwaysDropInsteadOfReplace | If true, drop and recreate a view instead of replacing it. | no | — |
| alwaysOverrideStoredLogicSchema | When generating SQL for createProcedure, should the procedure schema be forced to the default schema if no schemaName attribute is set? | no | — |
| analyticsConfigCacheTimeoutMillis | Liquibase caches the results from the config endpoint, and this value determines how long that cache should live for before being refreshed. | no | — |
| analyticsConfigEndpointTimeoutMillis | — | no | — |
| analyticsConfigEndpointUrl | — | no | — |
| analyticsDevOverride | By default, Liquibase will not send analytics in dev (non release) builds. To override this behavior, set this value to true and provide a value for liquibase.analytics.configEndpointUrl | no | — |
| analyticsEnabled | Enable or disable sending product usage data and analytics to Liquibase. Learn more at https://docs.liquibase.com/analytics. | no | — |
| analyticsLicenseKeyChars | Number of characters of the license key that should be appended to the userId. This is used in the event that the same customer has multiple license keys associated with them. | no | — |
| analyticsLogLevel | — | no | — |
| analyticsTimeoutMillis | By default, the timeout for sending data to the remote endpoint is configured in the config endpoint. Any value set here will override that value. | no | — |
| autoReorg | Should Liquibase automatically include REORG TABLE commands when needed? | no | — |
| changelogLockPollRate | Number of seconds wait between checks to the changelog lock when it is locked | no | — |
| changelogLockWaitTimeInMinutes | Number of minutes to wait for the changelog lock to be available before giving up | no | — |
| changelogParseMode | Configures how to handle unknown fields in changelog files. Possible values: STRICT which causes parsing to fail, and LAX which continues with the parsing. | no | — |
| checksCompatibilityEnabled | Enable liquibase-checks extension compatibility check. Can be used when running tests to turn off the check. | no | — |
| classpath | Additional classpath entries to use | no | — |
| convertDataTypes | Should Liquibase convert to/from STANDARD data types. Applies to both snapshot and update commands. | no | — |
| customLogDataFile | [PRO]Relative or fully qualified path to a yaml file containing key:value data to inject or exclude data from JSON structured logs. Learn more at https://docs.liquibase.com/structured-logging | no | — |
| customLogDataFrequency | [PRO]The frequency that the custom log data will be entered into the logs. Available options are: ONCE,REPEATED | no | — |
| databaseChangelogLockTableName | Name of table to use for tracking concurrent Liquibase usage | no | — |
| databaseChangelogTableName | Name of table to use for tracking change history | no | — |
| databaseClass | Class to use for Database implementation | no | — |
| db2zDatabasechangelogIndex | The index name for the DATABASECHANGELOG table on DB2 z/OS | no | — |
| db2zDatabasechangeloglockIndex | The index name for the DATABASECHANGELOGLOCK table on DB2 z/OS | no | — |
| db2zTrackingTablesLocationDatabase | The database name for the Liquibase tracking tables on DB2 z/OS | no | — |
| db2zTrackingTablesLocationTablespace | The tablespace name for the Liquibase tracking tables on DB2 z/OS | no | — |
| dbclhistoryCaptureExtensions | If true, extensions are captured in the history table | no | — |
| dbclhistoryCaptureSql | If true, executed SQL is captured in the history table | no | — |
| dbclhistoryEnabled | [PRO]This property enables Liquibase Pro users to store a record of all database changing liquibase operations in a new table DATABASECHANGELOGHISTORY. This table includes records of rollback, dropalls, and repeated runOnChange type activity, which is not available in the standard DATABASECHANGELOG table. | no | — |
| dbclhistorySeverity | The exit code to use if an exception is encountered while recording history events | no | — |
| dbclhistoryTableName | — | no | — |
| ddlLockTimeout | The DDL_LOCK_TIMEOUT parameter indicates the number of seconds a DDL command should wait for the locks to become available before throwing the resource busy error message. This applies only to Oracle databases. | no | — |
| defaultsFile | File with default Liquibase properties | no | — |
| diffColumnOrder | Should Liquibase compare column order in diff operation? | no | — |
| duplicateFileMode | How to handle multiple files being found in the search path that have duplicate paths. Options are SILENT (do not log and choose one at random), DEBUG, INFO, WARN (log at the given level and choose one at random), or ERROR (fail current operation). | no | — |
| errorOnCircularIncludeAll | Throw an error if Liquibase detects that an includeAll will cause a circular reference (and thus a changelog parse error). | no | — |
| fileEncoding | Encoding to use when reading files. Valid values include: UTF-8, UTF-16, UTF-16BE, UTF-16LE, US-ASCII, or OS to use the system configured encoding. | no | — |
| filterLogMessages | DEPRECATED: No longer used | no | — |
| flowVerboseToString | If true, display a more verbose output for the FlowFile toString representation | no | — |
| generateChangesetCreatedValues | Should Liquibase include a "created" attribute in diff/generateChangelog changesets with the current datetime | no | — |
| generatedChangesetIdsContainsDescription | Should Liquibase include the change description in the id when generating changesets? | no | — |
| headless | Force Liquibase to think it has no access to a keyboard | no | — |
| includeCatalogInSpecification | Should Liquibase include the catalog name when determining equality? | no | — |
| includeMatchingTagInRollbackOldest | If set to true, and there are multiple identical tags in the database changelog table, all of the newer matching tags will be rolled back while rolling back to the oldest tag. The default value for this option was false for all Liquibase versions equal to or older than 4.25.1. | no | — |
| includeRelationsForComputedColumns | If true, the parent relationship for computed columns is preserved in snapshot-dependent commands: snapshot and diff | no | — |
| includeSchemaNameForDefault | If true, the schema name is included for the default schema when loading a snapshot | no | — |
| includeSystemClasspath | Include the system classpath when resolving classes at runtime | no | — |
| integrationName | The name of the integration used to invoke Liquibase, for example, cli, or JavaAPI. It is not required to specify this value. This is primarily used by wrappers around Liquibase (like Gradle), so that analytics can be differentiated for those integrations. | no | — |
| jclCreateLogFile | If true, then write to a JCL log file | no | — |
| jclLogFilePath | Log file path for JCL output | no | — |
| jclMinimumErrorReturnCode | Minimum return code recognized as an error | no | — |
| jclOverwriteLogFile | If true, overwrite JCL log file | no | — |
| licenseUtilityEnabled | Enable or disable sending license usage data. | no | — |
| licenseUtilityLogLevel | — | no | — |
| licenseUtilityTimeout | Time, in milliseconds, to wait for HTTP request to complete | no | — |
| licenseUtilityTrackingId | Specifies an identifier (e.g., team name, pipeline ID, or environment) to track and analyze Liquibase license usage. If not provided, the hostname and user is used for identification. | no | — |
| licenseUtilityUrl | — | no | — |
| licenseKey | Liquibase Pro or Liquibase Labs license key used to unlock paid capabilities. Get a free trial at https://liquibase.com/trial and use in CLI or add liquibase.licenseKey=<yourKey> into your defaults file. | no | — |
| liquibaseCatalogName | Catalog to use for Liquibase objects | no | — |
| liquibaseSchemaName | Schema to use for Liquibase objects | no | — |
| liquibaseTablespaceName | Tablespace to use for Liquibase objects | no | — |
| logChannels | Controls which log channels have their level set by the liquibase.logLevel setting. Comma separate multiple values. To set the level of all channels, use "all". Example: liquibase,org.mariadb.jdbc | no | — |
| logFile | Users can use .gz file extension to enable log files compression. | no | — |
| logFormat | Sets the format of log output to console or log files. Open Source users default to unstructured "TEXT" logs to the console or output log files. Pro users have the option to set value as "JSON" or "JSON_PRETTY" to enable json-structured log files to the console or output log files. | no | — |
| logLevel | Controls which logs get set to stderr AND to any log file. The CLI defaults, if log file set, to SEVERE. Others vary by integration. The official log levels are: OFF, SEVERE, WARNING, INFO, FINE | no | — |
| mirrorConsoleMessagesToLog | When set to true, the console messages are mirrored to the logs as [liquibase.ui] to provide a more complete picture of liquibase operations to log analysis tools. Set to false to change this behavior. | no | — |
| mirrorOutputToConsole | [PRO]When set to true, console output will be mirrored to both the specified output-file and the console. If output-file is not set, the "mirror-output-to-console" argument has no effect. | no | — |
| missingPropertyMode | How to handle changelog property expressions where a value is not set. For example, a string "${address}" when no "address" property was defined. Values can be: "preserve" which leaves the string as-is, "empty" which replaces it with an empty string, or "error" which stops processing with an error. | no | — |
| monitorPerformance | Enable performance tracking. Set to "false" to disable. If set to "true", data is stored to a `liquibase-TIMESTAMP.jfr` file in your working directory. Any other value will enable tracking and be used as the name of the file to write the data to. | no | — |
| mysqlEnableDbclPrimaryKey | [PRO]Flag to enable composite primary key for newly added DBCL tables. Disabled by default | no | — |
| nativeExecutor | Custom executor that can specified | no | — |
| onMissingIncludeChangelog | If set to WARN, then liquibase will not throw exception on missing changelog file, instead will show a warning message. | no | — |
| onMissingSqlFile | If set to WARN, then Liquibase will not throw exception on missing sqlFile inside a sqlFile change type, instead will show a warning message | no | — |
| outputFile | — | no | — |
| outputFileEncoding | Encoding to use when writing files | no | — |
| outputLineSeparator | Line separator for output | no | — |
| preserveClasspathPrefixInNormalizedPaths | If true "classpath:" prefix will be preserved in normalized paths, allowing to resolve hierarchical resources under a classpath-based root. | no | — |
| preserveSchemaCase | If true, Liquibase treats schema and catalog names as case sensitive | no | — |
| proForceOnPartialChanges | If true, rollback execution will be forced when having partial changes that needs to be rolled back. Defaults to false. | no | — |
| proGlobalEndDelimiter | [PRO]The default end delimiter to use for all change sets | no | — |
| proGlobalEndDelimiterPrioritized | [PRO]If true, the global end delimiter overrides all other settings | no | — |
| proGlobalStripComments | [PRO]The default strip comments to use for all change sets | no | — |
| proGlobalStripCommentsPrioritized | [PRO]If true, the global strip comments overrides all other settings | no | — |
| proLicenseKey | DEPRECATED: Liquibase Pro license key used to unlock paid capabilities. Get a free trial at https://www.liquibase.com/protrial and use in CLI or add liquibase.pro.licenseKey=<yourKey> into your defaults file. | no | — |
| proMarkUnusedNotDrop | If a column would be dropped in a diffChangeLog, call markUnused instead if set to true | no | — |
| proSqlInline | If true, generate changeSets with SQL-based changes inlined instead of saving them to an external file | no | — |
| proSynonymsDropPublic | If false, do not drop public synonyms in diffChangeLog/dropAll | no | — |
| proStrict | [PRO]If true, the Liquibase operations will fail when specified paths to Pro resource files (flow files, checks settings files, native executor conf files, etc) or rollback scripts are missing or empty. | no | — |
| promptForNonLocalDatabase | Should Liquibase prompt if a non-local database is being accessed | no | — |
| propertyProviderClass | Implementation of Properties class to provide additional driver properties | no | — |
| reportsEnabled | [PRO]Enable or disable reporting. | no | — |
| reportsFormat | [PRO]The format of the report. Currently, can only be set to "html". | no | — |
| reportsName | [PRO]The name of the reports. | no | — |
| reportsOpen | [PRO]Open the newly generated report in your default browser. | no | — |
| reportsPath | [PRO]The path to the directory to generate the reports. | no | — |
| reportsQuiet | [PRO]Minimize the amount of logging when generating reports. | no | — |
| reportsSuppressException | [PRO]Global setting to prevent the display of exceptions in operation reports. | no | — |
| reportsSuppressSql | [PRO]Global setting to prevent the display of changeset SQL in operation reports. | no | — |
| scriptPythonExecutablePath | Path to a Python executable associated with a virtual environment | no | — |
| searchPath | Complete list of Location(s) to search for files such as changelog files in. Multiple paths can be specified by separating them with commas. | no | — |
| secureParsing | If true, remove functionality from file parsers which could be used insecurely. Examples include (but not limited to) disabling remote XML entity support. | no | — |
| shouldRun | Should Liquibase commands execute | no | — |
| shouldSnapshotData | Should Liquibase snapshot data by default? | no | — |
| showBanner | If true, show a Liquibase banner on startup. | no | — |
| showHiddenArgs | If true, all command arguments marked as hidden will be shown in the help output, ignoring the hidden flag. NOTE, due to the order of value provider loading at such an early point in Liquibase startup, you MUST set this as a environment variable. Command line parameters will not be recognized. | no | — |
| snowflakeAuthPrivateKeyPassphrase | [PRO]Path to private key used for PKI Authentication type. Usually requires "snowflake-auth-type" property configured. | no | — |
| snowflakeAuthPrivateKeyPath | [PRO]Path to private key used for PKI Authentication type. Usually requires "snowflake-auth-type" property configured. | no | — |
| snowflakeAuthToken | [PRO]Value of the token used for specified Authentication type. Usually requires "snowflake-auth-type" property configured. | no | — |
| snowflakeAuthType | [PRO]The type or mechanism of Snowflake database authentication | no | — |
| sqlAlwaysSetFetchSize | If true, all queries will have their fetch size set to the fetch size defined in their database implementation. This has the effect of informing the driver how many rows should be fetched when processing the result set. This is not guaranteed to be respected by the driver, but if respected, should improve query performance significantly. | no | — |
| sqlLogLevel | Level to log SQL statements to | no | — |
| sqlShowSqlWarnings | Show SQLWarning messages | no | — |
| strict | If true, Liquibase enforces certain best practices and proactively looks for common errors | no | — |
| supportPropertyEscaping | Support escaping changelog parameters using a colon. Example: ${:user.name} | no | — |
| supportsMethodValidationLevel | Controls the level of validation performed on the supports method of Change classes. Options are OFF, WARN, FAIL. | no | — |
| suppressLiquibaseSql | When set to true, this global property prevents DBCL and DBCLH sql from being present in console and logs during *-sql commands, such as update-sql, rollback-sql, etc. | no | — |
| trimLoadDataFileHeader | If true column headers will be trimmed in case they were specified with spaces in the file. | no | — |
| uiService | Changes the default UI Service Logger used by Liquibase. Options are CONSOLE or LOGGER. | no | — |
| useProcedureSchema | If set to true (default value), createProcedure tags with a set schemaName will modify the procedure body with the given schema name. | no | — |
| validateXmlChangelogFiles | Will perform XSD validation of XML changelog files. When many XML changelog files are included, this validation may impact Liquibase performance. Defaults to true. | no | — |
| workaroundOracleClobCharacterLimit | If true, long strings in Oracle will be chunked at 4000 characters when an insert statement is run, to avoid running afoul of Oracle"s 4000 character limit for insert statements to clob type columns (which appears as "ORA-01704: string literal too long.") | no | — |
Outputs
no outputs