refactor(builder): Create `sap-ui-version.json` by default by maxreichmann · Pull Request #1453 · UI5/cli

maxreichmann · 2026-07-16T14:20:07Z

JIRA: CPOUI5FOUNDATION-1157

What has been done?

Exclusion of task generateVersionInforemoved
- now it will be executed by default for every build of project type application (default, jsdoc, self-contained)
Tests refactored accordingly
- +new test verifying exclusion/inclusion of generateVersionInfo: ProjectBuilder.integration.js:2758
Docs
- migrate-v5.md: new section explaining new behavior
- Builder.md: changed generateVersionInfo from disabled to enabled in Standard Tasks table

Info

for Server:
- task generateVersionInfo is explicitly NOT executed because middleware versionInfo IS executed (which creates sap-ui-version.json anyways)
- Test verifying exclusion of generateVersionInfo: BuildServer.integration.js:1030
- (existing) Test verifying sap-ui-version.json is generated: server/test/lib/server/main.js:204

matz3 · 2026-07-20T11:15:52Z

We should also check how this now relates to the versionInfo middleware. My assumption would be that we need to keep the middleware to serve the file for non-application projects (and when the task was skipped?). For application projects, we should be able to just serve the file from the application build output. This should at least be tested, confirmed and documented.

maxreichmann · 2026-07-22T10:14:36Z

Update:

generateVersionInfo is now excluded from server builds (for normal builds, it's executed by default).
Tests are added and existing ones are adjusted.
Docs are adjusted.
--> Main part is done and ready for review.

"Side tasks done": I'm also fine to move those changes out to another PR if this eases the review process.

matz3

"Side tasks done": I'm also fine to move those changes out to another PR if this eases the review process.

Yes, I think that would help with reviewing the docs changes. Thanks for looking into that!

maxreichmann · 2026-07-24T07:41:28Z

~~Removing the Draft state of this PR to check merge conflicts~~

~~❗️ Pls don't start a review yet :)~~

maxreichmann · 2026-07-24T09:16:52Z

✅ Update: Rebased. CI problems now fixed. PR ready for review

This PR includes the outsourced "Side tasks done" from original PR #1453. Following changes have been made: * docs: Replace hardcoded URLs (ui5.github.io/..) with dynamic links * docs: Replace dead "API Reference" links * Guide the reader to use the new sidebar menu * Add "📚" emoji to "API" in sidebar to mimic depr. API Reference button * docs: Add links to all Builder tasks in Standard Tasks table * refactor(internal/documentation): Remove of npm script `jsdoc` (deprecated & not used in CI) * Remove now unused dep `open-cli`

matz3

LGTM, just a minor comment.

Documentation changes look fine to me.

`+` Fix some related tests

`+` Adjust Standard Tasks table (TODO: check `transformBootstrapHTML` link!!)

`+` docs: Replace hardcoded URLs (ui5.github.io/..) with dynamic links `+` docs: Add links to all Builder tasks in Standard Tasks table `+` refactor: Remove "jsdoc" npm script (+remove unused dep `open-cli`)

(versionInfo middleware still runs -> sap-ui-version.json is generated) `+` add test verifying exclusion `+` adjust docs stating this exclusion

(from ProjectGraph.js to server.js) This logic will affect the `ui5 serve` command but not the internal BuildServer now.

Co-authored-by: Merlin Beutlberger <m.beutlberger@sap.com>

Refactored `checkFileContentsIgnoreLineFeeds()` along by removing unused check for `sap-ui-cachebuster-info.json` (+Cleanup)

maxreichmann · 2026-07-28T11:52:25Z

Rebased and test problem fixed. Review ready again

RandomByte · 2026-07-28T15:12:03Z

 				"arm64"
 			],
 			"dev": true,
-			"libc": [


package.json was not modified, so this change might not be intended?

This happens when running npm install with npm v10.x or maybe also with an older v11.x version.
Please use the latest npm v11.x instead (currently 11.18.0).

RandomByte · 2026-07-28T15:16:44Z

+			if (!expected.executedTasks) {
+				continue; // no executedTasks specified -> skip the check
+			}
+			const expectedExecuted = expected.executedTasks || [];


Already checked above?

Suggested change

const expectedExecuted = expected.executedTasks || [];

const expectedExecuted = expected.executedTasks;

RandomByte · 2026-07-28T15:26:25Z

+	if (!Array.isArray(excludedTasks)) {
+		excludedTasks = [];
+	}
+	if (!excludedTasks.includes("generateVersionInfo")) {
+		excludedTasks = [...excludedTasks, "generateVersionInfo"];
+	}


Removing these lines only causes failure of a single unit test that is actually for the serveIndex middleware.

I see that server.js only has very basic unit tests as of today, but I think at last stubbing and validating the arguments provided to graph.serve would be good here.

maxreichmann changed the title ~~refactor(builder): Remove default exclusion of "generateVersionInfo"~~ refactor(builder): Remove default exclusion of generateVersionInfo Jul 16, 2026

maxreichmann changed the title ~~refactor(builder): Remove default exclusion of generateVersionInfo~~ refactor(builder): Run generateVersionInfo by default Jul 20, 2026

maxreichmann force-pushed the run-generateVersionInfo-by-default branch 5 times, most recently from f354410 to b6ca355 Compare July 22, 2026 10:11

matz3 reviewed Jul 22, 2026

View reviewed changes

Comment thread internal/documentation/docs/pages/Builder.md Outdated

Comment thread internal/documentation/docs/pages/Builder.md Outdated

Comment thread packages/project/lib/graph/ProjectGraph.js Outdated

maxreichmann mentioned this pull request Jul 22, 2026

docs: Several refactorings #1473

Draft

maxreichmann force-pushed the run-generateVersionInfo-by-default branch 6 times, most recently from fe552c6 to da4d1f4 Compare July 23, 2026 10:20

maxreichmann mentioned this pull request Jul 24, 2026

refactor(builder): Run generateVersionInfo by default #1476

Closed

maxreichmann marked this pull request as ready for review July 24, 2026 07:41

maxreichmann force-pushed the run-generateVersionInfo-by-default branch 3 times, most recently from 0a42367 to 8827f4e Compare July 24, 2026 08:54

maxreichmann requested a review from a team July 24, 2026 09:17

RandomByte reviewed Jul 24, 2026

View reviewed changes

Comment thread packages/server/lib/server.js Outdated

flovogt mentioned this pull request Jul 27, 2026

[ROADMAP] UI5 CLI 5.0 / Specification Version 5.0 #976

Open

17 tasks

matz3 reviewed Jul 28, 2026

View reviewed changes

Comment thread packages/builder/test/lib/builder/builder.js Outdated

maxreichmann changed the title ~~refactor(builder): Run generateVersionInfo by default~~ refactor(builder): Create sap-ui-version.json by default Jul 28, 2026

maxreichmann and others added 12 commits July 28, 2026 12:06

refactor(builder): Remove default exclusion of "generateVersionInfo"

e388d1f

`+` Fix some related tests

test(project): Adjust ProjectBuilder tests

f42cc02

test(project): Adjust BuildServer tests

7fbe410

docs: Add section to migrate-v5

8102fc8

`+` Adjust Standard Tasks table (TODO: check `transformBootstrapHTML` link!!)

docs: Refactor migration text

7b038de

docs: Replace dead "API ref" links with sidebar menu guide

7b68767

`+` docs: Replace hardcoded URLs (ui5.github.io/..) with dynamic links `+` docs: Add links to all Builder tasks in Standard Tasks table `+` refactor: Remove "jsdoc" npm script (+remove unused dep `open-cli`)

test(project): Add test with exclusion of generateVersionInfo

9112743

refactor(project): Exclude task generateVersionInfo from server builds

6acf9e5

(versionInfo middleware still runs -> sap-ui-version.json is generated) `+` add test verifying exclusion `+` adjust docs stating this exclusion

refactor: Move "Side tasks done" out to dedicated PR (#1473)

f1649a2

docs: Add sentence for ui5 serve

d9a4c59

refactor: Move exclusion logic of generateVersionInfo

e66f756

(from ProjectGraph.js to server.js) This logic will affect the `ui5 serve` command but not the internal BuildServer now.

refactor: Apply suggestion

08268f1

Co-authored-by: Merlin Beutlberger <m.beutlberger@sap.com>

maxreichmann force-pushed the run-generateVersionInfo-by-default branch from 59b0286 to 08268f1 Compare July 28, 2026 10:06

test: Fix endsWith() problem

b527bf5

Refactored `checkFileContentsIgnoreLineFeeds()` along by removing unused check for `sap-ui-cachebuster-info.json` (+Cleanup)

maxreichmann force-pushed the run-generateVersionInfo-by-default branch from d95996b to b527bf5 Compare July 28, 2026 11:21

matz3 reviewed Jul 28, 2026

View reviewed changes

Comment thread packages/builder/test/lib/builder/builder.js Outdated

test: Fix try/catch issue

9a51d5c

maxreichmann force-pushed the run-generateVersionInfo-by-default branch from b3c403d to 9a51d5c Compare July 28, 2026 14:00

RandomByte requested changes Jul 28, 2026

View reviewed changes

	const expectedExecuted = expected.executedTasks \|\| [];
	const expectedExecuted = expected.executedTasks;

Uh oh!

Conversation

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

Uh oh!

Uh oh!

matz3 commented Jul 20, 2026

Uh oh!

maxreichmann commented Jul 22, 2026

Uh oh!

matz3 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

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

Uh oh!

Uh oh!

maxreichmann commented Jul 24, 2026

Uh oh!

Uh oh!

matz3 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

maxreichmann commented Jul 28, 2026

Uh oh!

Uh oh!

RandomByte Jul 28, 2026

Choose a reason for hiding this comment

Uh oh!

matz3 Jul 28, 2026

Choose a reason for hiding this comment

Uh oh!

RandomByte Jul 28, 2026

Choose a reason for hiding this comment

Uh oh!

RandomByte Jul 28, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

maxreichmann commented Jul 16, 2026 •

edited

Loading

maxreichmann commented Jul 24, 2026 •

edited

Loading