Skip to content

Commit bec30a6

Browse files
committed
feat(documentation): Document Specification Version 5.0
1 parent c1b1432 commit bec30a6

File tree

2 files changed

+17
-20
lines changed

2 files changed

+17
-20
lines changed

packages/documentation/docs/index.md

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -22,14 +22,6 @@ An open and modular toolchain to develop state-of-the-art applications based on
2222
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)**
2323
:::
2424

25-
::: tip New Release
26-
**UI5 CLI V4 is here 🎉**
27-
28-
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)**
29-
30-
And checkout the **[Migrate to v4](./updates/migrate-v4.md)** documentation.
31-
:::
32-
3325
<div style="margin: 2rem 0;">
3426
<VPButton class="no-decoration" text="🚀 Get Started" href="./pages/GettingStarted.md"/>
3527
</div>
@@ -57,7 +49,7 @@ Configure your project for use with UI5 CLI.
5749
❯ ui5 init
5850
Wrote ui5.yaml:
5951
60-
specVersion: "4.0"
52+
specVersion: "5.0"
6153
metadata:
6254
name: my-app
6355
type: application

packages/documentation/docs/pages/Configuration.md

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ See the list of [clients](https://github.com/redhat-developer/yaml-language-serv
1818
## Example
1919

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

3838
```yaml [application]
39-
specVersion: "4.0"
39+
specVersion: "5.0"
4040
type: application
4141
```
4242

4343
```yaml [library]
44-
specVersion: "4.0"
44+
specVersion: "5.0"
4545
type: library
4646
```
4747

4848
```yaml [theme-library]
49-
specVersion: "4.0"
49+
specVersion: "5.0"
5050
type: theme-library
5151
```
5252

5353
```yaml [module]
54-
specVersion: "4.0"
54+
specVersion: "5.0"
5555
type: module
5656
```
5757

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

278278
```yaml [application]
279-
specVersion: "4.0"
279+
specVersion: "5.0"
280280
type: application
281281
metadata:
282282
name: my.company.app
@@ -291,7 +291,7 @@ framework:
291291
```
292292

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

647647
::: details Example
648648
```yaml
649-
specVersion: "4.0"
649+
specVersion: "5.0"
650650
type: application
651651
metadata:
652652
name: my.application
653653
---
654-
specVersion: "4.0"
654+
specVersion: "5.0"
655655
kind: extension
656656
type: project-shim
657657
metadata:
658658
name: my.application.thirdparty
659659
shims:
660660
configurations:
661661
lodash:
662-
specVersion: "4.0"
662+
specVersion: "5.0"
663663
type: module
664664
metadata:
665665
name: lodash
@@ -752,7 +752,7 @@ A list of bundle definitions. A `bundleDefinition` contains of the following opt
752752
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.
753753

754754
```yaml
755-
specVersion: "4.0"
755+
specVersion: "5.0"
756756
[...]
757757
```
758758

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

772772
Version | UI5 CLI Release
773773
--- | ---
774+
**5.0** | v5.0.0+
774775
**4.0** | v4.0.0+
775776
**3.2** | v3.8.0+
776777
**3.1** | v3.5.0+
@@ -786,6 +787,10 @@ Version | UI5 CLI Release
786787
**1.0** | v1.0.0+
787788
**0.1** | v0.0.1+
788789

790+
### Specification Version 5.0
791+
792+
Specification Version 5.0 projects are supported by [UI5 CLI](https://github.com/UI5/cli) v5.0.0 and above.
793+
789794
### Specification Version 4.0
790795

791796
**Breaking changes:**

0 commit comments

Comments
 (0)