Skip to content

Repositories and Building

themarioga edited this page Nov 8, 2026 · 1 revision

Repositories and Building

TIE is split in three repositories. The modules live in their own repositories and are included in the main one as git submodules; the published Maven artifacts are the same whatever the layout.

Repository Contents
tie-integration-engine/tie The aggregator: parent pom (tie-parent), Maven wrapper, examples, CI, README and changelog. Includes the two modules as submodules
tie-integration-engine/tie-core The library (tie-core)
tie-integration-engine/tie-spring-boot-starter The Spring Boot 4 starter (tie-spring-boot-starter)

Each module repository keeps the full history of its module (extracted with git subtree split) and a v0.1.0 tag on the commit of the 0.1.0 release. The modules need the parent pom, so they are always built from the aggregator.

Cloning

git clone --recurse-submodules https://github.com/tie-integration-engine/tie.git

In a clone made without submodules, or after pulling a commit that moves them:

git submodule update --init

The submodules are cloned over HTTPS, so no SSH key is needed to read them. To push with SSH:

git -C tie-core remote set-url --push origin git@github.com:tie-integration-engine/tie-core.git
git -C tie-spring-boot-starter remote set-url --push origin git@github.com:tie-integration-engine/tie-spring-boot-starter.git

Building

From the aggregator, with Java 25:

./mvnw verify                          # every module: unit and integration tests (embedded SFTP server)
./mvnw -P release verify               # also the slow tests (1 GB streams), sources and javadoc
./mvnw -pl tie-core -am verify         # one module only
./mvnw install                         # then build the examples against the installed artifacts:
./mvnw -f examples/plain-java/pom.xml verify
./mvnw -f examples/spring-boot/pom.xml verify

Tests tagged slow only run with -P release. The integration tests run with a 256 MB heap to check that files are read in streaming.

Changing a module

A submodule is checked out at a fixed commit (a "detached HEAD"). To change it:

cd tie-core
git switch main
# … edit, build from the aggregator, commit …
git push
cd ..
git add tie-core                       # record the new module commit in the aggregator
git commit -m "Update tie-core"
git push

Push the module first: the aggregator must never point to a module commit that is not on GitHub. A change that touches both modules means one commit in each module repository and one in the aggregator that moves both pointers.

Continuous integration

Repository What the CI does
tie Checks out the submodules, runs ./mvnw -P release install (slow tests, sources and javadoc included) and builds both examples
tie-core Checks out the aggregator, replaces its tie-core submodule with the commit under test and runs -P release install -pl tie-core -am
tie-spring-boot-starter The same with the starter; tie-core comes from the aggregator's submodule

A module's CI therefore tests the module against the aggregator's current main.

Releasing

Versions are shared by the three repositories. To release version X.Y.Z:

  1. In the module repositories and in the aggregator, set the version (the poms of the parent, the modules and the examples, and the dependency snippets of the README and this wiki) and date the changelog.

  2. Commit and push each module, then the aggregator with both pointers updated.

  3. Tag vX.Y.Z in the three repositories.

  4. Publish from a checkout of the aggregator tag, with its submodules:

    ./mvnw -P release,central deploy

    The central profile signs with GPG and uploads the deployment to the Central Portal without publishing it (autoPublish=false). Check that it is VALIDATED, then publish it from the portal. A version published on Maven Central can never be changed or deleted.

  5. Create the GitHub release on the aggregator, and move the poms to the next -SNAPSHOT.

Publishing needs a GPG key on a public keyserver and a Central Portal token in ~/.m2/settings.xml (server id central). The namespace is io.github.tie-integration-engine.

Clone this wiki locally