Split liquibase-core and liquibase-commercial jar files #3050

nvoxland · 2022-07-08T14:47:35Z

Impact

Bug fix (non-breaking change which fixes expected existing functionality)
Enhancement/New feature (adds functionality without impacting existing logic)
Breaking change (fix or feature that would cause existing functionality to change)

Description

Rather than having liquibase-core contain both the functionality from this repository as well as the commercial code, keep "liquibase-core" as the base, open source library and create a new "liquibase-commercial" as the additional proprietary/commercial functionality.

The new liquibase-commercial.jar file will be available:

In maven central
As an additional asset on release pages
As an additional jar in the liquibase-artifacts.zip and liquibase-artifacts-<BRANCH_NAME>.zip build artifacts

For consistency, the liquibase-core.jar file will now be stored as liquibase-core.jar on the build and release assets pages rather than liquibase.jar like it previously was.

Impacts

CLI

The liquibase CLI distributions will continue to include both liquibase-core.jar and liquibase-commerical.jar in the internal/lib directory**, so there is no impact for CLI users,** regardless of what distribution is used (tar.gz file, zip file, or docker image). The existing liquibase launch scripts have been updated to use the correct jar files.

While we will not ship a CLI distribution without liquibase-commercial.jar, removing any non-open source code is simply a matter of deleting internal/lib/liquibase-commercial.jar

NOTE: The liquibase-core.jar file was previously called liquibase.jar and stored in the root of LIQUIBASE_HOME. So anyone working directly with the liquibase.jar file will need to update their usage to use internal/lib/liquibase-core.jar.

NOTE: If you upgrade over an existing LIQUIBASE_HOME installation, the old liquibase.jar file will continue to exist because there is no logic to clean up old files. It can be deleted at your leisure, and it will not be used by Liquibase if left.

Maven Plugin

The Liquibase-maven-plugin will now depend on both liquibase-core and liquibase-commercial instead of just liquibase-core. This means that anyone using the maven plugin as:

            <plugin>
                <groupId>org.liquibase</groupId>
                <artifactId>liquibase-maven-plugin</artifactId>
                ...

will continue to be able to use both free and paid functionality with no changes to their configuration.

Servlet / Spring / Ant Integrations

See "User Managed Dependencies" below

User Managed Dependencies

Any projects that were directly or indirectly referencing or using "liquibase-core" will no longer include the commercial functionality. To continue to use Liquibase Pro features, you need to have both liquibase-core.jar and liquibase-commercial.jar as part of your project.

If you are managing your project using a tools that follows Maven managed dependencies (Maven, Gradle, Ivy, etc.), the easiest approach is to change your dependency on liquibase-core to liquibase-commercial. Because liquibase-commercial defines liquibase-core as a dependency, you will automatically get both included in your project without having to manage multiple dependencies yourself.

If you are not directly referencing liquibase-core yourself, but it is comes along as a transitive dependency (like if you use spring-boot), add org.liquibase:liquibase-commercial as an additional dependency in your project.

…aces

# Conflicts: # liquibase-dist/pom.xml # liquibase-dist/src/main/assembly/assembly-bin.xml

github-actions · 2022-07-08T18:37:19Z

Unit Test Results

  4 608 files ±0   4 608 suites ±0 42m 4s ⏱️ + 3m 37s
  4 593 tests ±0   4 375 ✔️ - 4   218 💤 +4 0 ❌ ±0
54 288 runs ±0 49 276 ✔️ - 4 5 012 💤 +4 0 ❌ ±0

Results for commit 68556e4. ± Comparison against base commit eb62560.

♻️ This comment has been updated with latest results.

nvoxland · 2022-07-11T20:32:06Z

Corresponding PRs:

Added liquibase-commercial dependency liquibase-test-harness#301
liquibase/liquibase-pro#565
liquibase/liquibase-pro-tests#388

nvoxland · 2022-07-11T20:38:28Z

Things to test:

In the build's liquibase-artifacts-*.zip artifacts:
- Both liquibase-core.jar and liquibase-commercial.jar exist
The liquibase-core.jar:
- Does not include a liquibase/pro directory
The liquibase-maven-plugin.jar's:
- META-INF/maven/.../pom.xml file has both liquibase-core and liquibase-commercial as dependnecies
The liquibase-commercial-jar:
- Has liquibase-core as a dependency
- Has correct license and other metadata
- Does not include any other dependencies
The liquibase.tar.gz:
- Has no /liquibase.jar file
- Has liquibase-core.jar and liquibase-commercial.jar in internal/lib
- Has no additional or missing internal/lib jar files vs 4.13.0 besides liquibase-commercial.jar

…0497 # Conflicts: # liquibase-dist/pom.xml

nvoxland · 2022-07-13T20:53:17Z

I think this is all working now, including the "re-version" logic. I tested that with a test run of the action.

liquibase-core/src/main/resources/liquibase/examples/start-h2.bat

…0497 # Conflicts: # liquibase-dist/pom.xml

FBurguer · 2022-07-15T16:18:51Z

TEST:

MacOS Installer:

Pro Features access denied without Pro Key: PASS
Pro Features access with Pro Key: PASS
Pro Features unavailble with Pro Key and deleting liquibase-commercial.jar: PASS

Windows Installer:

Pro Features access denied without Pro Key: PASS
Pro Features access with Pro Key: PASS
Pro Features unavailble with Pro Key and deleting liquibase-commercial.jar: PASS

Ant Integration:

Pro Features access denied without Pro Key and with liquibase-commercial.jar included: PASS
Pro Features access with Pro Key and with liquibase-commercial.jar included: PASS
Pro Features unavailble with Pro Key but without liquibase-commercial.jar included: PASS
Upgrade from core to Pro with liquibase-commercial.jar included and Pro Key: PASS

Servlet Integration:

Pro Features access denied without Pro Key: PASS
Pro Features access with Pro Key (not available at the moment but the code is accesable): PASS
Pro Features unavailble with Pro Key but without liquibase-commercial.jar included: PASS
Upgrade from core to Pro with liquibase-commercial.jar included and Pro Key(not available at the moment but the code is accesable): PASS

.zip file:

Pro Features access denied without Pro Key: PASS
Pro Features access with Pro Key: PASS
Pro Features unavailble with Pro Key and deleting liquibase-commercial.jar: PASS

.tar file:

Pro Features access denied without Pro Key: PASS
Pro Features access with Pro Key: PASS
Pro Features unavailble with Pro Key and deleting liquibase-commercial.jar: PASS

Spring-boot/Spring integration:

Pro Features access denied without Pro Key: PASS
Pro Features access with Pro Key (not available at the moment but the code is accesable): PASS
Pro Features unavailble with Pro Key but without liquibase-commercial.jar included: PASS
Upgrade from core to Pro with liquibase-commercial.jar included and Pro Key(not available at the moment but the code is accesable): PASS

Maven plug-in:

Pro Features access denied without Pro Key: PASS
Pro Features access with Pro Key: PASS
(there is no way to exclude liquibase-commercial.jar at the momment)

FBurguer · 2022-07-15T16:22:11Z

Post Release distributions tests pending:

Gradle Integration
liquibase.org/download
Hombrew
Choclatery
Docker

# Conflicts: # liquibase-cli/src/main/java/liquibase/integration/commandline/LiquibaseLauncher.java # liquibase-dist/pom.xml

kataggart · 2022-07-21T13:20:36Z

this PR makes me so happy
that is all

ap-liquibase and others added 5 commits June 8, 2022 16:10

DAT-10497 change liquibase-pro to liquibase-commercial in relevant pl…

19cf99d

…aces

DAT-10497 add liquibase-commercial as a dependency to lb oss release pom

b689b5c

Merge branch 'master' into github-action-DAT-10497

4e8f172

# Conflicts: # liquibase-dist/pom.xml # liquibase-dist/src/main/assembly/assembly-bin.xml

Working on commercial vs. core jar split

77fa075

Working on commercial vs. core jar split

0e72fa5

Working on commercial vs. core jar split

a94ff4a

kataggart added the ReleaseMajor Fix needs to be part of an x.y release, not an x.y.z patch release label Jul 11, 2022

kataggart added this to To Do in Conditioning++ via automation Jul 11, 2022

nvoxland added 3 commits July 11, 2022 10:46

Working on commercial vs. core jar split

d54afbf

Working on commercial vs. core jar split

306e957

Working on commercial vs. core jar split

f835ce8

nvoxland mentioned this pull request Jul 11, 2022

Added liquibase-commercial dependency liquibase/liquibase-test-harness#301

Merged

Working on commercial vs. core jar split

a5cb088

kataggart added CodeDistro enabler labels Jul 12, 2022

jnewton03 assigned nvoxland Jul 12, 2022

jnewton03 requested review from jnewton03, ap-liquibase and StevenMassaro July 12, 2022 13:40

nvoxland added 7 commits July 12, 2022 16:20

Updating release logic for new liquibase-core/liquibase-commerical jars

445ea96

Updating release logic for new liquibase-core/liquibase-commerical jars

b3826b7

Updating release logic for new liquibase-core/liquibase-commerical jars

0cba1f4

Updating release logic for new liquibase-core/liquibase-commerical jars

1c44a24

Merge remote-tracking branch 'origin/master' into github-action-DAT-1…

d78faaf

…0497 # Conflicts: # liquibase-dist/pom.xml

Merged master into branch

57b9e5a

Updating release logic for new liquibase-core/liquibase-commerical jars

eeeb69a

nvoxland requested a review from suryaaki2 July 13, 2022 20:52

suryaaki2 approved these changes Jul 13, 2022

View reviewed changes

StevenMassaro approved these changes Jul 14, 2022

View reviewed changes

liquibase-core/src/main/resources/liquibase/examples/start-h2.bat Outdated Show resolved Hide resolved

jnewton03 approved these changes Jul 14, 2022

View reviewed changes

nvoxland added 2 commits July 14, 2022 15:25

Working on commercial vs. core jar split

ecb0f83

Merge remote-tracking branch 'origin/master' into github-action-DAT-1…

a3bd00d

…0497 # Conflicts: # liquibase-dist/pom.xml

kataggart assigned FBurguer Jul 15, 2022

nvoxland added this to the NEXT milestone Jul 15, 2022

nvoxland added 3 commits July 15, 2022 13:38

Updated "XSD not found" error message to include missing extensions

f4669ad

Updated "XSD not found" error message to include missing extensions

94df4b4

Updated "XSD not found" error message to include missing extensions

1a9a005

kataggart added DocNeeded marketingRequired labels Jul 19, 2022

Merge branch 'master' into github-action-DAT-10497

68556e4

# Conflicts: # liquibase-cli/src/main/java/liquibase/integration/commandline/LiquibaseLauncher.java # liquibase-dist/pom.xml

kataggart linked an issue Jul 20, 2022 that may be closed by this pull request

Provide Liquibase jar without packaged dependencies and pro packages #2629

Closed

nvoxland merged commit bbbd3a8 into master Jul 20, 2022

Conditioning++ automation moved this from To Do to Done Jul 20, 2022

nvoxland deleted the github-action-DAT-10497 branch July 20, 2022 21:20

kataggart added the sprint2022-29 label Jul 21, 2022

StevenMassaro mentioned this pull request Jul 22, 2022

fix pro commands in maven plugin #3100

Closed

3 tasks

famod mentioned this pull request Jul 27, 2022

Update Liquibase to 4.14.0 and resolve most deprecation warnings quarkusio/quarkus#26977

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Split liquibase-core and liquibase-commercial jar files #3050

Split liquibase-core and liquibase-commercial jar files #3050

nvoxland commented Jul 8, 2022 •

edited

github-actions bot commented Jul 8, 2022 •

edited

nvoxland commented Jul 11, 2022

nvoxland commented Jul 11, 2022 •

edited

nvoxland commented Jul 13, 2022

FBurguer commented Jul 15, 2022 •

edited

FBurguer commented Jul 15, 2022 •

edited

kataggart commented Jul 21, 2022

Split liquibase-core and liquibase-commercial jar files #3050

Split liquibase-core and liquibase-commercial jar files #3050

Conversation

nvoxland commented Jul 8, 2022 • edited

Impact

Description

Impacts

CLI

Maven Plugin

Servlet / Spring / Ant Integrations

User Managed Dependencies

github-actions bot commented Jul 8, 2022 • edited

Unit Test Results

nvoxland commented Jul 11, 2022

nvoxland commented Jul 11, 2022 • edited

nvoxland commented Jul 13, 2022

FBurguer commented Jul 15, 2022 • edited

FBurguer commented Jul 15, 2022 • edited

kataggart commented Jul 21, 2022

nvoxland commented Jul 8, 2022 •

edited

github-actions bot commented Jul 8, 2022 •

edited

nvoxland commented Jul 11, 2022 •

edited

FBurguer commented Jul 15, 2022 •

edited

FBurguer commented Jul 15, 2022 •

edited