Skip to content

refactor(builder): Create sap-ui-version.json by default #1453

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.

Sign up for GitHub

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

Open
maxreichmann wants to merge 15 commits into
base: main
Choose a base branch
from
Open

refactor(builder): Create sap-ui-version.json by default #1453

Show file tree
Hide file tree
Changes from 14 commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
e388d1f
refactor(builder): Remove default exclusion of "generateVersionInfo"
maxreichmann Jul 16, 2026
f42cc02
test(project): Adjust ProjectBuilder tests
maxreichmann Jul 17, 2026
7fbe410
test(project): Adjust BuildServer tests
maxreichmann Jul 17, 2026
8102fc8
docs: Add section to migrate-v5
maxreichmann Jul 17, 2026
7b038de
docs: Refactor migration text
maxreichmann Jul 20, 2026
7b68767
docs: Replace dead "API ref" links with sidebar menu guide
maxreichmann Jul 21, 2026
9112743
test(project): Add test with exclusion of `generateVersionInfo`
maxreichmann Jul 21, 2026
6acf9e5
refactor(project): Exclude task `generateVersionInfo` from server builds
maxreichmann Jul 22, 2026
f1649a2
refactor: Move "Side tasks done" out to dedicated PR (#1473)
maxreichmann Jul 22, 2026
d9a4c59
docs: Add sentence for `ui5 serve`
maxreichmann Jul 23, 2026
e66f756
refactor: Move exclusion logic of `generateVersionInfo`
maxreichmann Jul 23, 2026
08268f1
refactor: Apply suggestion
maxreichmann Jul 24, 2026
b527bf5
test: Fix `endsWith()` problem
maxreichmann Jul 28, 2026
9a51d5c
test: Fix try/catch issue
maxreichmann Jul 28, 2026
d982c4f
refactor: Address @RandomByte review
maxreichmann Jul 29, 2026
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
5 changes: 3 additions & 2 deletions internal/documentation/docs/pages/Builder.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ All available standard tasks are documented [in the API reference](https://ui5.g
| generateBundle | *disabled* <sup>4</sup> | *disabled* <sup>4</sup> | *disabled* <sup>4</sup> | |
| buildThemes | | | enabled | enabled |
| generateThemeDesignerResources | | | *disabled* <sup>5</sup> | *disabled* <sup>5</sup> |
| generateVersionInfo | *disabled* <sup>1</sup> | | | |
| generateVersionInfo | enabled <sup>6</sup> | | | |
| generateCachebusterInfo | *disabled* | *disabled* | | |
| generateApiIndex | *disabled* <sup>1</sup> | | | |
| generateResourcesJson | *disabled* | *disabled* | *disabled* | *disabled* |
Expand All @@ -57,7 +57,8 @@ All available standard tasks are documented [in the API reference](https://ui5.g
<sup>2</sup> Enabled for projects defining a [component preload configuration](./Configuration.md#component-preload-generation)
<sup>3</sup> Enabled in `self-contained` build, which disables `generateComponentPreload` and `generateLibraryPreload`
<sup>4</sup> Enabled for projects defining a [bundle configuration](./Configuration.md#custom-bundling)
<sup>5</sup> Can be enabled for framework projects via the `includeTask` option. For other projects, this task is skipped
<sup>5</sup> Can be enabled for framework projects via the `includeTask` option. For other projects, this task is skipped
<sup>6</sup> Disabled for the server due to a corresponding middleware producing the same output

### minify

Expand Down
4 changes: 4 additions & 0 deletions internal/documentation/docs/pages/Server.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,10 @@ In case a directory has been requested, this middleware renders an HTML with a l
## Standard Tasks
As with the UI5 Builder, a set of standard tasks is being executed during a server build. Individual tasks can be included or excluded using the respective CLI options `--include-task` and `--exclude-task`.

::: info Exception
For the server, task [`generateVersionInfo`](../api/module-@ui5_builder_tasks_generateVersionInfo.md) is not executed because the corresponding middleware [`versionInfo`](#versioninfo) creates the same output file `sap-ui-version.json`.

@KlattG KlattG Jul 31, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
For the server, task [`generateVersionInfo`](../api/module-@ui5_builder_tasks_generateVersionInfo.md) is not executed because the corresponding middleware [`versionInfo`](#versioninfo) creates the same output file `sap-ui-version.json`.
For the server, the [`generateVersionInfo`](../api/module-@ui5_builder_tasks_generateVersionInfo.md) task is not executed, because the corresponding [`versionInfo`](#versioninfo) middleware creates an identical `sap-ui-version.json` output file.

:::

::: info
See [Builder Standard Tasks](./Builder.md#standard-tasks) for more explanation about each task.
:::
Expand Down
10 changes: 10 additions & 0 deletions internal/documentation/docs/updates/migrate-v5.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -320,6 +320,16 @@ Update your `ui5.yaml` configuration to reference an existing middleware instead
| `serveThemes` | CSS files pre-built by `buildThemes` task and served via `serveResources` | `serveResources` |
| `testRunner` | TestRunner resources served via `serveResources` from the UI5 framework | `serveResources` |

## `sap-ui-version.json`

When running `ui5 build`, the standard task [`generateVersionInfo`](../api/module-@ui5_builder_tasks_generateVersionInfo) (producing a `sap-ui-version.json` file under `resources/`) is now **executed by default**. This applies to every build type (default, jsdoc, and self-contained) for projects of type `application`. For projects of other types (e.g. `library`), the behavior remains the same and [`generateVersionInfo`](../api/module-@ui5_builder_tasks_generateVersionInfo) is not executed.

@KlattG KlattG Jul 31, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
When running `ui5 build`, the standard task [`generateVersionInfo`](../api/module-@ui5_builder_tasks_generateVersionInfo) (producing a `sap-ui-version.json` file under `resources/`) is now **executed by default**. This applies to every build type (default, jsdoc, and self-contained) for projects of type `application`. For projects of other types (e.g. `library`), the behavior remains the same and [`generateVersionInfo`](../api/module-@ui5_builder_tasks_generateVersionInfo) is not executed.
When you run `ui5 build`, the standard task [`generateVersionInfo`](../api/module-@ui5_builder_tasks_generateVersionInfo) now runs by default. This task generates an `sap-ui-version.json` file in the `resources/` directory. The task runs for all build types (default, jsdoc, and self-contained) in projects of type `application`. For other project types (such as `library`), the behavior remains unchanged: [`generateVersionInfo`](../api/module-@ui5_builder_tasks_generateVersionInfo) does not run.


::: info Tip
To see which standard tasks are executed for each project type, check out the [Standard Tasks](../pages/Builder#standard-tasks) table in the UI5 Builder page.
:::

When running `ui5 serve`, [`generateVersionInfo`](../api/module-@ui5_builder_tasks_generateVersionInfo) continues to **not be executed by default** because a corresponding middleware [`versionInfo`](../pages/Server.md#versioninfo) produces the same `sap-ui-version.json` output file.

@KlattG KlattG Jul 31, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
When running `ui5 serve`, [`generateVersionInfo`](../api/module-@ui5_builder_tasks_generateVersionInfo) continues to **not be executed by default** because a corresponding middleware [`versionInfo`](../pages/Server.md#versioninfo) produces the same `sap-ui-version.json` output file.
When running `ui5 serve`, [`generateVersionInfo`](../api/module-@ui5_builder_tasks_generateVersionInfo) continues to
not run by default. The [`versionInfo`](../pages/Server.md#versioninfo) middleware creates an identical `sap-ui-version.json` output file.


## Learn More

- [Project: Type `component`](../pages/Project#component)
Expand Down
Loading
Loading