Fluent Commerce Logo
Docs

Modules as the Unit of Deployment

Essential knowledgeCore knowledge to understand Fluent Commerce

Changed on:

9 Nov 2026

Overview

[Warning: empty required content area]

Key points

[Warning: empty required content area]
A Fluent module packages everything an implementation adds to an account: rule plugins, workflows, settings and other assets, described by `module.json`. Deploy modules, not individual workflows or JARs. One module install keeps the rules and the workflows that call them in step.

What belongs in a module

In the moduleOutside the module
Rule plugin JARsCredentials and secrets
WorkflowsRetailer IDs and other account-specific identifiers
Settings whose value is the same in every environmentSettings whose value differs per environment (supply them through module config)
`module.json`, `module.config.json`, README, CHANGELOGTest data and reference data loads
Declare reference modules you depend on in `module.json` so an install into an account that lacks them fails early:

Versioning

Use a single version for the whole module, shared by the archive, `module.json` and the rule plugin JAR.
  • Developers author `major.minor` in one place: the `<revision>` property of the plugin reactor `pom.xml`. The committed `resources/module.json` carries the same value.
  • CI appends a build identifier, a build number or git tag, to produce the full version, for example `1.0.412`.
  • Only the `dist/` copy is stamped. The build writes the full version into the `module.json` inside `dist/` and passes it to Maven as `-Drevision`. Committed files never change during a build.
This matters because the CLI matches the rule JAR against the version in `module.json`. If the two disagree, the CLI skips the JAR upload without failing: the deploy looks green but ships no rules. Have the build fail on a mismatch before it zips anything.
Sample `build-module.sh` (abridged)

Per-environment configuration

`module.config.json` declares what a module needs from the environment. Commit one filled-in config per retailer per module under `cicd/configs/`, named `module.config.<RETAILER>.<module>.json`, and have the install step apply it with `fluent module config` before `fluent module install`.`cicd/configs/` also serves as the list of modules each retailer expects. A preflight step can use it to confirm that the reference modules the implementation builds on (order, inventory and so on) are already installed before it installs anything (see profile.sh).

Blueprints

When an implementation spans several modules, or you need to pin the exact reference-module versions an account must carry, describe the set as a blueprint. A blueprint lists exact module versions, so it works as a release manifest you can install, validate (`fluent blueprint validate`) and download for offline or pinned installs (`fluent blueprint download`). A single extension module, as in the samples here, does not need one.