feat: Offer --cache option to control cache mode (Incremental Build) by maxreichmann · Pull Request #1368 · UI5/cli

maxreichmann · 2026-04-28T17:02:22Z

Part of Incremental Build: #1267

JIRA: CPOUI5FOUNDATION-1208

Introduce --cache with values "Default", "ReadOnly", "Force" and "Off" for commands "ui5 build" and "ui5 serve"
- Add yargs help description (also appears in CLI docs)
Add JSDoc annotations
Rename --cache-mode to --snapshot-cache
- Hide deprecated option in yargs help (if still used -> logs warning)
- Legacy logic now usable via new name
- Add hint under "Migrate to v5" in docs explaining this

maxreichmann · 2026-05-11T12:43:15Z

Rebased onto base branch feat/incremental-build-4 and fixed all unit tests which are not failing in base branch.

Fix all unit tests which are NOT failing in base branch ("feat-incremental-build-4")

RandomByte · 2026-05-13T15:17:02Z

Adding @KlattG since this PR changes a lot of user-facing texts

Co-authored-by: Florian Vogt <florian.vogt@sap.com>

KlattG

Nothing major, just a few things I noticed

KlattG · 2026-05-22T05:49:45Z

+
+With UI5 CLI v5, the option `--cache-mode` (for commands `ui5 build` and `ui5 serve`) has been renamed to `--snapshot-cache`.
+
+When legacy `--cache-mode` is used, the behavior remains the same but a deprecation warning is logged. When both `--snapshot-cache` and `--cache-mode` are used, successor `--snapshot-cache` always gets priority.


Suggested change

When legacy `--cache-mode` is used, the behavior remains the same but a deprecation warning is logged. When both `--snapshot-cache` and `--cache-mode` are used, successor `--snapshot-cache` always gets priority.

When legacy `--cache-mode` is used, the behavior remains the same but a deprecation warning is logged. When both `--snapshot-cache` and `--cache-mode` are used, the `--snapshot-cache` flag always gets priority.

KlattG · 2026-05-22T05:53:15Z

+				"The 'Default' behavior is to always use the cache if available. 'Force' uses the cache only " +
+				"(if it's unavailable or invalid, the build fails). 'ReadOnly' does not create or update any " +


Suggested change

"The 'Default' behavior is to always use the cache if available. 'Force' uses the cache only " +

"(if it's unavailable or invalid, the build fails). 'ReadOnly' does not create or update any " +

"The 'Default' behavior is to always use the cache if available. 'Force' uses the cache only. " +

"If the cache is unavailable or invalid, the build fails. 'ReadOnly' does not create or update any " +

KlattG · 2026-05-22T05:54:30Z

+		.coerce("cache-mode", (opt) => {
+			// Log a warning if this option is used
+			if (opt !== undefined) {
+				log.warn("As of UI5 CLI version 5, '--cache-mode' was renamed to '--snapshot-cache'. " +


Suggested change

log.warn("As of UI5 CLI version 5, '--cache-mode' was renamed to '--snapshot-cache'. " +

log.warn("As of UI5 CLI version 5, '--cache-mode' is renamed to '--snapshot-cache'. " +

KlattG · 2026-05-22T05:55:27Z

+				"The 'Default' behavior is to always use the cache if available. 'Force' uses the cache only " +
+				"(if it's unavailable or invalid, the build fails). 'Read-only' does not create or update any " +


see above

Suggested change

"The 'Default' behavior is to always use the cache if available. 'Force' uses the cache only " +

"(if it's unavailable or invalid, the build fails). 'Read-only' does not create or update any " +

"The 'Default' behavior is to always use the cache if available. 'Force' uses the cache only. " +

"If the cache is unavailable or invalid, the build fails. 'Read-only' does not create or update any " +

KlattG · 2026-05-22T05:57:12Z

+		.coerce("cache-mode", (opt) => {
+			// Log a warning if this option is used
+			if (opt !== undefined) {
+				log.warn("As of UI5 CLI version 5, '--cache-mode' was renamed to '--snapshot-cache'. " +


Suggested change

log.warn("As of UI5 CLI version 5, '--cache-mode' was renamed to '--snapshot-cache'. " +

log.warn("As of UI5 CLI version 5, '--cache-mode' is renamed to '--snapshot-cache'. " +

KlattG · 2026-05-22T06:00:21Z

+ * @readonly
+ * @enum {string}
+ * @property {string} Default Use cache if available
+ * @property {string} Force Use cache only (if it's unavailable or invalid, the build fails)


Suggested change

* @property {string} Force Use cache only (if it's unavailable or invalid, the build fails)

* @property {string} Force Use cache only. If the cache is unavailable or invalid, the build fails

maxreichmann force-pushed the feat/incremental-build-cache-mode branch from 13173d5 to 68a130f Compare April 29, 2026 07:39

maxreichmann marked this pull request as draft April 29, 2026 07:42

maxreichmann force-pushed the feat/incremental-build-cache-mode branch from 68a130f to 0c087f8 Compare April 29, 2026 08:23

RandomByte force-pushed the feat/incremental-build-4 branch from e1d781f to ab65f27 Compare April 30, 2026 12:19

RandomByte requested changes May 4, 2026

View reviewed changes

Comment thread packages/cli/lib/cli/commands/build.js Outdated

Comment thread packages/cli/lib/cli/commands/build.js Outdated

maxreichmann force-pushed the feat/incremental-build-4 branch from 7aa4cd3 to 95fd5de Compare May 5, 2026 13:14

maxreichmann force-pushed the feat/incremental-build-cache-mode branch from e451d07 to 07a5941 Compare May 7, 2026 15:25

maxreichmann marked this pull request as ready for review May 7, 2026 15:31

maxreichmann force-pushed the feat/incremental-build-cache-mode branch from bbf7099 to 39431de Compare May 7, 2026 15:32

maxreichmann requested review from a team and RandomByte May 7, 2026 15:32

RandomByte force-pushed the feat/incremental-build-4 branch from 0670d94 to d029efb Compare May 11, 2026 08:45

maxreichmann force-pushed the feat/incremental-build-cache-mode branch 2 times, most recently from 7994eae to 2546932 Compare May 11, 2026 10:25

maxreichmann added 4 commits May 11, 2026 12:31

feat: Introduce --cache option for ui5 build & ui5 serve

736f443

refactor: Use cacheMode as fallback for snapshotCache (Address review)

f8dc182

refactor: Reorder CLI parameter docs list (set --cache higher)

cba86f0

refactor: Remove unnecessary test fixtures

4db0fca

maxreichmann force-pushed the feat/incremental-build-cache-mode branch from 2546932 to 4db0fca Compare May 11, 2026 10:32

maxreichmann requested review from RandomByte and removed request for RandomByte May 11, 2026 12:43

refactor: Fix unit tests

f2ff30d

Fix all unit tests which are NOT failing in base branch ("feat-incremental-build-4")

maxreichmann force-pushed the feat/incremental-build-cache-mode branch from cafca18 to f2ff30d Compare May 12, 2026 09:24

maxreichmann force-pushed the feat/incremental-build-4 branch from 4be8ab8 to 7164b79 Compare May 13, 2026 12:35

RandomByte requested changes May 13, 2026

View reviewed changes

Comment thread internal/documentation/docs/updates/migrate-v5.md Outdated

RandomByte requested a review from KlattG May 13, 2026 15:16

docs: Fix Migrate-v5 hints (Review)

db051ab

maxreichmann force-pushed the feat/incremental-build-cache-mode branch from 6e065f0 to db051ab Compare May 19, 2026 11:43

flovogt reviewed May 19, 2026

View reviewed changes

Comment thread internal/documentation/docs/updates/migrate-v5.md Outdated

docs: Fix Migrate-v5 hints (@flovogt review)

876b2f3

Co-authored-by: Florian Vogt <florian.vogt@sap.com>

maxreichmann force-pushed the feat/incremental-build-cache-mode branch from 7dec71b to 876b2f3 Compare May 19, 2026 14:56

RandomByte force-pushed the feat/incremental-build-4 branch from c9c4972 to 2862e0f Compare May 20, 2026 14:31

KlattG requested changes May 22, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Offer --cache option to control cache mode (Incremental Build)#1368

feat: Offer --cache option to control cache mode (Incremental Build)#1368
maxreichmann wants to merge 7 commits into
feat/incremental-build-4from
feat/incremental-build-cache-mode

maxreichmann commented Apr 28, 2026 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

maxreichmann commented May 11, 2026 •

edited

Loading

Uh oh!

Uh oh!

RandomByte commented May 13, 2026

Uh oh!

Uh oh!

KlattG left a comment

Uh oh!

KlattG May 22, 2026

Uh oh!

KlattG May 22, 2026

Uh oh!

KlattG May 22, 2026

Uh oh!

KlattG May 22, 2026

Uh oh!

KlattG May 22, 2026

Uh oh!

KlattG May 22, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants


		With UI5 CLI v5, the option `--cache-mode` (for commands `ui5 build` and `ui5 serve`) has been renamed to `--snapshot-cache`.

		When legacy `--cache-mode` is used, the behavior remains the same but a deprecation warning is logged. When both `--snapshot-cache` and `--cache-mode` are used, successor `--snapshot-cache` always gets priority.

		"The 'Default' behavior is to always use the cache if available. 'Force' uses the cache only " +
		"(if it's unavailable or invalid, the build fails). 'ReadOnly' does not create or update any " +

	log.warn("As of UI5 CLI version 5, '--cache-mode' was renamed to '--snapshot-cache'. " +
	log.warn("As of UI5 CLI version 5, '--cache-mode' is renamed to '--snapshot-cache'. " +

	* @property {string} Force Use cache only (if it's unavailable or invalid, the build fails)
	* @property {string} Force Use cache only. If the cache is unavailable or invalid, the build fails

Conversation

maxreichmann commented Apr 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

maxreichmann commented May 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

RandomByte commented May 13, 2026

Uh oh!

Uh oh!

KlattG left a comment

Choose a reason for hiding this comment

Uh oh!

KlattG May 22, 2026

Choose a reason for hiding this comment

Uh oh!

KlattG May 22, 2026

Choose a reason for hiding this comment

Uh oh!

KlattG May 22, 2026

Choose a reason for hiding this comment

Uh oh!

KlattG May 22, 2026

Choose a reason for hiding this comment

Uh oh!

KlattG May 22, 2026

Choose a reason for hiding this comment

Uh oh!

KlattG May 22, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

maxreichmann commented Apr 28, 2026 •

edited

Loading

maxreichmann commented May 11, 2026 •

edited

Loading