Skip to content

feat(project): Add Specification Version 5.0 #1177

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

Merged
merged 5 commits into from
Nov 10, 2025
Merged

feat(project): Add Specification Version 5.0 #1177

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
31e22f6
feat(project): Add Specification Version 5.0
RandomByte Oct 31, 2025
5892749
feat(cli): Use specVersion 5.0 in init command
RandomByte Nov 6, 2025
e4d0406
feat(documentation): Document Specification Version 5.0
RandomByte Nov 6, 2025
7e51732
docs(documentation): Replace all occurrence of specVersion 4.0 with 5.0
RandomByte Nov 6, 2025
8fdc243
docs(documentation): Remove whitespace
RandomByte Nov 10, 2025
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
2 changes: 1 addition & 1 deletion packages/cli/lib/init/init.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ function getProjectType(hasWebapp, hasSrc, hasTest) {
*/
async function init({cwd = "./"} = {}) {
const projectConfig = {
specVersion: "4.0",
specVersion: "5.0",
metadata: {}
};
let pkg;
Expand Down
4 changes: 2 additions & 2 deletions packages/cli/test/lib/init/init.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ test("Init for application", async (t) => {
});

t.deepEqual(projectConfig, {
specVersion: "4.0",
specVersion: "5.0",
type: "application",
metadata: {
name: "init-application"
Expand All @@ -32,7 +32,7 @@ test("Init for library", async (t) => {
});

t.deepEqual(projectConfig, {
specVersion: "4.0",
specVersion: "5.0",
type: "library",
metadata: {
name: "init-library"
Expand Down
10 changes: 1 addition & 9 deletions packages/documentation/docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,6 @@ An open and modular toolchain to develop state-of-the-art applications based on
Read the announcement blog post: **[SAP Community: Goodbye UI5 Tooling - Hello UI5 CLI!](https://community.sap.com/t5/technology-blog-posts-by-sap/goodbye-ui5-tooling-hello-ui5-cli/ba-p/14211769)**
:::

::: tip New Release
**UI5 CLI V4 is here 🎉**

Read the announcement blog post: **[SAP Community: UI5 CLI 4.0](https://community.sap.com/t5/technology-blogs-by-sap/ui5-tooling-4-0/ba-p/13769578)**

And checkout the **[Migrate to v4](./updates/migrate-v4.md)** documentation.
:::

<div style="margin: 2rem 0;">
<VPButton class="no-decoration" text="🚀 Get Started" href="./pages/GettingStarted.md"/>
</div>
Expand Down Expand Up @@ -57,7 +49,7 @@ Configure your project for use with UI5 CLI.
❯ ui5 init
Wrote ui5.yaml:

specVersion: "4.0"
specVersion: "5.0"
metadata:
name: my-app
type: application
Expand Down
27 changes: 16 additions & 11 deletions packages/documentation/docs/pages/Configuration.md
View file
Open in desktop
Copy link
Member

@matz3 matz3 Nov 12, 2025

Choose a reason for hiding this comment

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

In line 6 we still refer to Specification Version 3.0
This should also be adjusted in the v4 branch.

Copy link
Member Author

@RandomByte RandomByte Nov 12, 2025

Choose a reason for hiding this comment

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

Done in #1190

Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ See the list of [clients](https://github.com/redhat-developer/yaml-language-serv
## Example

```yaml
specVersion: "4.0"
specVersion: "5.0"
type: application|library|theme-library|module
metadata:
name: some.project.name
Expand All @@ -36,22 +36,22 @@ The type defines the default path mappings and build tasks. See [UI5 Builder: Ty
:::code-group Example

```yaml [application]
specVersion: "4.0"
specVersion: "5.0"
type: application
```

```yaml [library]
specVersion: "4.0"
specVersion: "5.0"
type: library
```

```yaml [theme-library]
specVersion: "4.0"
specVersion: "5.0"
type: theme-library
```

```yaml [module]
specVersion: "4.0"
specVersion: "5.0"
type: module
```

Expand Down Expand Up @@ -276,7 +276,7 @@ Projects that use the OpenUI5 framework cannot depend on projects that use the S
::: code-group Example

```yaml [application]
specVersion: "4.0"
specVersion: "5.0"
type: application
metadata:
name: my.company.app
Expand All @@ -291,7 +291,7 @@ framework:
```

```yaml [library]
specVersion: "4.0"
specVersion: "5.0"
type: library
metadata:
name: my.company.library
Expand Down Expand Up @@ -646,20 +646,20 @@ The default and configured server ports can always be overwritten with the CLI p

::: details Example
```yaml
specVersion: "4.0"
specVersion: "5.0"
type: application
metadata:
name: my.application
---
specVersion: "4.0"
specVersion: "5.0"
kind: extension
type: project-shim
metadata:
name: my.application.thirdparty
shims:
configurations:
lodash:
specVersion: "4.0"
specVersion: "5.0"
type: module
metadata:
name: lodash
Expand Down Expand Up @@ -752,7 +752,7 @@ A list of bundle definitions. A `bundleDefinition` contains of the following opt
A project must define a specification version by setting the `specVersion` property. UI5 CLI uses this information to detect whether the currently installed version is compatible to a project's configuration.

```yaml
specVersion: "4.0"
specVersion: "5.0"
[...]
```

Expand All @@ -771,6 +771,7 @@ Unless otherwise noted in the table below, UI5 CLI modules are backward compatib

Version | UI5 CLI Release
--- | ---
**5.0** | v5.0.0+
**4.0** | v4.0.0+
**3.2** | v3.8.0+
**3.1** | v3.5.0+
Expand All @@ -786,6 +787,10 @@ Version | UI5 CLI Release
**1.0** | v1.0.0+
**0.1** | v0.0.1+

### Specification Version 5.0

Specification Version 5.0 projects are supported by [UI5 CLI](https://github.com/UI5/cli) v5.0.0 and above.

### Specification Version 4.0

**Breaking changes:**
Expand Down
4 changes: 2 additions & 2 deletions packages/documentation/docs/pages/OpenUI5.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ ui5 add sap.ui.core sap.m sap.ui.table themelib_sap_fiori_3

**Example ui5.yaml of an application**
```yaml
specVersion: "4.0"
specVersion: "5.0"
type: application
metadata:
name: some.project.name
Expand All @@ -43,7 +43,7 @@ framework:

**Example ui5.yaml of a library**
```yaml
specVersion: "4.0"
specVersion: "5.0"
type: library
metadata:
name: some.library
Expand Down
4 changes: 2 additions & 2 deletions packages/documentation/docs/pages/SAPUI5.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ ui5 add -D sap.ushell

**Example ui5.yaml of an application**
```yaml
specVersion: "4.0"
specVersion: "5.0"
type: application
metadata:
name: some.project.name
Expand All @@ -58,7 +58,7 @@ framework:

**Example ui5.yaml of a library**
```yaml
specVersion: "4.0"
specVersion: "5.0"
type: library
metadata:
name: some.library
Expand Down
8 changes: 4 additions & 4 deletions packages/documentation/docs/pages/extensibility/CustomServerMiddleware.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ A middleware may be executed before or after any other middleware. This can eith
### Example: Basic configuration

```yaml
specVersion: "4.0"
specVersion: "5.0"
type: application
metadata:
name: my.application
Expand Down Expand Up @@ -45,7 +45,7 @@ A custom middleware extension consists of a `ui5.yaml` and a [custom middleware
### Example: ui5.yaml

```yaml
specVersion: "4.0"
specVersion: "5.0"
kind: extension
type: server-middleware
metadata:
Expand All @@ -65,7 +65,7 @@ The UI5 Server will detect the custom middleware configuration of the project an

```yaml
# Project configuration for the above example
specVersion: "4.0"
specVersion: "5.0"
kind: project
type: application
metadata:
Expand All @@ -76,7 +76,7 @@ server:
beforeMiddleware: serveResources
---
# Custom middleware extension as part of your project
specVersion: "4.0"
specVersion: "5.0"
kind: extension
type: server-middleware
metadata:
Expand Down
10 changes: 5 additions & 5 deletions packages/documentation/docs/pages/extensibility/CustomTasks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Another custom task called `render-markdown-files` is then executed immediately

```yaml
# In this example configuration, two custom tasks are defined: 'babel' and 'render-markdown-files'.
specVersion: "4.0"
specVersion: "5.0"
type: library
metadata:
name: my.library
Expand All @@ -41,7 +41,7 @@ You can also connect multiple custom tasks with each other. The order in the con

```yaml
# In this example, 'my-custom-task-2' gets executed after 'my-custom-task-1'.
specVersion: "4.0"
specVersion: "5.0"
type: library
metadata:
name: my.library
Expand All @@ -60,7 +60,7 @@ A custom task extension consists of a `ui5.yaml` and a [task implementation](#ta
### Example: ui5.yaml

```yaml
specVersion: "4.0"
specVersion: "5.0"
kind: extension
type: task
metadata:
Expand All @@ -80,7 +80,7 @@ The task extension will then be automatically collected and processed during the

```yaml
# Project configuration for the above example
specVersion: "4.0"
specVersion: "5.0"
kind: project
type: library
metadata:
Expand All @@ -94,7 +94,7 @@ builder:
firstH1IsTitle: true
---
# Task extension as part of your project
specVersion: "4.0"
specVersion: "5.0"
kind: extension
type: task
metadata:
Expand Down
22 changes: 11 additions & 11 deletions packages/documentation/docs/pages/extensibility/ProjectShims.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,20 @@ Also see [RFC 0002 Project Shims](https://github.com/UI5/cli/blob/main/rfcs/0002

#### Structure
```yaml
specVersion: "4.0"
specVersion: "5.0"
kind: extension
type: project-shim
metadata:
name: <name of project shim extension>
shims:
configurations:
<module name (id)>:
specVersion: "4.0"
specVersion: "5.0"
type: <project type>
metadata:
name: <project name>
<module name (id)>:
specVersion: "4.0"
specVersion: "5.0"
type: <project type>
metadata:
name: <project name>
Expand Down Expand Up @@ -61,20 +61,20 @@ An application "my-application" defines a npm dependency to [lodash](https://lod

**ui5.yaml**
```yaml
specVersion: "4.0"
specVersion: "5.0"
type: application
metadata:
name: my.application
--- # Everything below this line could also be put into the ui5.yaml of a standalone extension module
specVersion: "4.0"
specVersion: "5.0"
kind: extension
type: project-shim
metadata:
name: my.application.thirdparty
shims:
configurations:
lodash: # name as defined in package.json
specVersion: "4.0"
specVersion: "5.0"
type: module # Use module type
metadata:
name: lodash
Expand Down Expand Up @@ -142,30 +142,30 @@ application-a/
The shim defined in the application configures the legacy libraries and defines their dependencies. This shim might as well be a standalone module that is added to the applications dependencies. That would be the typical reuse scenario for shims.

```yaml
specVersion: "4.0"
specVersion: "5.0"
type: application
metadata:
name: application.a
----
specVersion: "4.0"
specVersion: "5.0"
kind: extension
type: project-shim
metadata:
name: legacy-lib-shims
shims:
configurations:
legacy-library-a:
specVersion: "4.0"
specVersion: "5.0"
type: library
metadata:
name: legacy.library.a
legacy-library-b:
specVersion: "4.0"
specVersion: "5.0"
type: library
metadata:
name: legacy.library.b
legacy-library-x:
specVersion: "4.0"
specVersion: "5.0"
type: library
metadata:
name: legacy.library.x
Expand Down
3 changes: 2 additions & 1 deletion packages/project/lib/specifications/SpecificationVersion.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ const SUPPORTED_VERSIONS = [
"0.1", "1.0", "1.1",
"2.0", "2.1", "2.2", "2.3", "2.4", "2.5", "2.6",
"3.0", "3.1", "3.2",
"4.0"
"4.0",
"5.0",
];

/**
Expand Down
2 changes: 1 addition & 1 deletion packages/project/lib/validation/schema/specVersion/kind/extension.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"type": "object",
"required": ["specVersion", "kind", "type", "metadata"],
"properties": {
"specVersion": { "enum": ["4.0", "3.2", "3.1", "3.0", "2.6", "2.5", "2.4", "2.3", "2.2", "2.1", "2.0"] },
"specVersion": { "enum": ["5.0", "4.0", "3.2", "3.1", "3.0", "2.6", "2.5", "2.4", "2.3", "2.2", "2.1", "2.0"] },
"kind": {
"enum": ["extension"]
},
Expand Down
4 changes: 2 additions & 2 deletions packages/project/lib/validation/schema/specVersion/kind/extension/project-shim.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@
"required": ["specVersion", "kind", "type", "metadata", "shims"],
"if": {
"properties": {
"specVersion": { "enum": ["3.0", "3.1", "3.2", "4.0"] }
"specVersion": { "enum": ["3.0", "3.1", "3.2", "4.0", "5.0"] }
}
},
"then": {
"additionalProperties": false,
"properties": {
"specVersion": {
"enum": ["3.0", "3.1", "3.2", "4.0"]
"enum": ["3.0", "3.1", "3.2", "4.0", "5.0"]
},
"kind": {
"enum": ["extension"]
Expand Down
Loading