Liquibase Git Resource

Liquibase extension to clone a remote Git repository and add it to the Liquibase Search Path.

Supported product editions

Requirements

• Liquibase 4.18.0 +

Installation

The easiest way to install this extension is with lpm liquibase package manager.

lpm update
lpm add liquibase-git-resource

Setup

If a valid Git URL is added to the Liquibase Search Path this extension will clone the repository to a local temporary directory. The location can be specified with liquibase.git.path and by default will be removed after liquibase has finished the command.

Optional parameters

--git-branch=PARAM
    Git branch to clone into git.path.  Can be specified as ref name (refs/heads/main), branch name (main) or tag name (v1.2.3)
    (liquibase.git.branch)
    (LIQUIBASE_GIT_BRANCH)
    [deprecated: --gitBranch]

--git-cleanup=PARAM
    Remove local repository path after run
    DEFAULT: true
    (liquibase.git.cleanup)
    (LIQUIBASE_GIT_CLEANUP)
    [deprecated: --gitCleanup]

--git-password=PARAM
    Git password for searchPath repository URL
    (liquibase.git.password)
    (LIQUIBASE_GIT_PASSWORD)
    [deprecated: --gitPassword]

--git-path=PARAM
    Path in which to clone repository
    DEFAULT: .tmp
    (liquibase.git.path)
    (LIQUIBASE_GIT_PATH)
    [deprecated: --gitPath]

--git-username=PARAM
    Git username for searchPath repository URL
    (liquibase.git.username)
    (LIQUIBASE_GIT_USERNAME)
    [deprecated: --gitUsername]

Example

Cloning a Public Repository:

liquibase.searchPath= https://github.com/liquibase/liquibase-github-action-example.git
changeLogFile= example/changelogs/samplechangelog.h2.sql

Cloning a Private Repository:

liquibase.searchPath= https://github.com/private-org/private-repository.git
changeLogFile= example/changelogs/samplechangelog.h2.sql

git.username= username
git.password= password or personal_access_token

Feedback and Issues

Please submit all feedback and issues here.