Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(deps)!: update hale dependencies to v6 (major) #156

Merged
merged 1 commit into from
Sep 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions .github/renovate.json5
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,14 @@
],
packageRules: [
{
description: "Treat major hale studio updates as breaking change",
description: "Treat major hale-core updates as breaking change",
matchPackagePrefixes: ["eu.esdihumboldt.hale:"],
matchUpdateTypes: ["major"],
semanticCommitType: "feat!" // to be confirmed that this works
semanticCommitType: "feat!", // works, but ! is before scope
semanticCommitScope: "" // remove scope TODO confirm this works as expected
},
{
description: "Treat minor hale studio updates as feature",
description: "Treat minor hale-core updates as feature",
matchPackagePrefixes: ["eu.esdihumboldt.hale:"],
matchUpdateTypes: ["minor"],
semanticCommitType: "feat"
Expand Down
34 changes: 8 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,14 @@ hale-cli
hale command line interface.
Lists available commands when run without arguments.

From version 5 onwards, hale-cli versions don't necessarily resemble the version of the respective [hale»studio](https://github.com/halestudio/hale) dependencies used.
From version 6 onwards hale-cli is based on [hale-core](https://github.com/halestudio/hale-core). The version of hale-cli does not necessarily resemble the version of the hale-core dependencies used.
Here you can find an overview on which version of hale-core is used:

| hale-cli | hale-core (major version) | Java
|----------|---------------------------| ----
| 6.x | 6 | 17

Earlier versions of hale-cli were based on [hale»studio](https://github.com/halestudio/hale) dependencies.
Here you can find an overview on which hale»studio version is used:

| hale-cli | hale»studio (major version) | Java
Expand All @@ -15,7 +22,6 @@ Here you can find an overview on which hale»studio version is used:
| 4.x | 4 | 8
| 3.x | 3 | 8


Build
-----

Expand Down Expand Up @@ -63,30 +69,6 @@ If using `./gradlew installDist`, the start script can be found in `./build/inst

JVM parameters can be provided to the start script with the `HALE_OPTS` environment variable.


Use custom hale studio dependencies during development
------------------------------------------------------

If you do changes to hale studio and want to test your changes with hale-cli in your local environment, then you need to perform these steps:

1. Build hale studio locally and publish the related artifacts to you local Maven repository.

For that change to the `build/` folder in your hale studio checkout and run the following command:

```
./build.sh clean && ./build.sh installArtifacts`
```
2. Make sure that in the `build.gradle` file the line adding the `mavenLocal` repository is uncommented (see [here](https://github.com/halestudio/hale-cli/blob/1ac56a52c359e52d71fe210b1cc4681aa53e3edb/build.gradle#L40)).
3. If necessary adapt the version of the hale-studio dependencies to the ones you published (see [here](https://github.com/halestudio/hale-cli/blob/1ac56a52c359e52d71fe210b1cc4681aa53e3edb/build.gradle#L29)).

Gradle will then take care to use the local dependencies.
If you want to create a local build of hale-cli that you want to use, you can for instance run

```
./gradlew clean installDist
```


Configuration
-------------

Expand Down
23 changes: 9 additions & 14 deletions build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ java {
group = 'to.wetransform'

project.ext {
haleVersion = '5.4.0-SNAPSHOT'
haleCoreVersion = '6.0.0'
groovyVersion = '2.5.23'
}

Expand All @@ -42,11 +42,6 @@ project.ext {
repositories {
// mavenLocal() //XXX for testing

// merge both snapshot and release repositories to virtual repository named local
// because gradle was reporting error if it encountered dependencies from snapshots
// but libs-release-local was placed before snapshots here in the hierarchy and also
// vice-versa case when dependencies were encountered from release but snapshots
// was placed before release
maven {
// wetransform release repository (HALE releases and Eclipse dependencies)
url 'https://artifactory.wetransform.to/artifactory/local'
Expand All @@ -69,30 +64,30 @@ dependencies {
// HALE

// BOM
implementation(platform("eu.esdihumboldt.hale:bom:$haleVersion"))
implementation(platform("eu.esdihumboldt.hale:bom:$haleCoreVersion"))

/*
* Features
*/

// CLI and core hale libraries & resources
implementation "eu.esdihumboldt.hale:eu.esdihumboldt.hale.app.feature.cli:$haleVersion"
implementation "eu.esdihumboldt.hale:eu.esdihumboldt.hale.app.feature.cli"

// core I/O providers and core hale libraries & resources
implementation "eu.esdihumboldt.hale:eu.esdihumboldt.hale.io.feature.core:$haleVersion"
implementation "eu.esdihumboldt.hale:eu.esdihumboldt.hale.io.feature.core"

// HTML export
implementation "eu.esdihumboldt.hale:eu.esdihumboldt.hale.io.feature.html:$haleVersion"
implementation "eu.esdihumboldt.hale:eu.esdihumboldt.hale.io.feature.html"

/*
* Additional formats
*/

implementation "eu.esdihumboldt.hale:eu.esdihumboldt.hale.io.jdbc.mssql:$haleVersion"
implementation "eu.esdihumboldt.hale:eu.esdihumboldt.hale.io.jdbc.msaccess:$haleVersion"
implementation "eu.esdihumboldt.hale:eu.esdihumboldt.hale.io.jdbc.mssql"
implementation "eu.esdihumboldt.hale:eu.esdihumboldt.hale.io.jdbc.msaccess"

// Schematron validation
implementation "eu.esdihumboldt.hale:eu.esdihumboldt.hale.io.schematron:$haleVersion"
implementation "eu.esdihumboldt.hale:eu.esdihumboldt.hale.io.schematron"
// replacement for omitted Saxon dependency
// tested w/ schematron validation in https://github.com/wetransform/exp-schematron/tree/exp/saxon-he
implementation 'net.sf.saxon:Saxon-HE:9.9.1-8'
Expand All @@ -102,7 +97,7 @@ dependencies {
*/

// user / customer specific
implementation "eu.esdihumboldt.hale:eu.esdihumboldt.hale.adv.merge:$haleVersion"
implementation "eu.esdihumboldt.hale:eu.esdihumboldt.hale.adv.merge"

// Groovy
implementation "org.codehaus.groovy:groovy-all:$groovyVersion"
Expand Down
Loading