Skip to content
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

Jump to bottom

[INTERNAL] Configuration: Document specification version 3.1 #863

Merged
merged 2 commits into from
Aug 22, 2023
Merged

[INTERNAL] Configuration: Document specification version 3.1 #863

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
01fa62e
[INTERNAL] Configuration: Document specification version 3.1
RandomByte Aug 22, 2023
6387e3f
[INTERNAL] Use specVersion 3.1 in all examples
RandomByte Aug 22, 2023
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
8 changes: 4 additions & 4 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Configure your project for use with UI5 Tooling.
❯ ui5 init
Wrote ui5.yaml:

specVersion: '3.0'
specVersion: '3.1'
RandomByte marked this conversation as resolved.
Show resolved Hide resolved
metadata:
name: my-app
type: application
Expand All @@ -40,9 +40,9 @@ type: application
UI5 framework dependencies are managed by the tooling. All other dependencies are managed by your favorite node package manager.

```
❯ ui5 use SAPUI5@1.76.0
❯ ui5 use SAPUI5@1.117.0
Updated configuration written to ui5.yaml
This project is now using SAPUI5 version 1.76.0
This project is now using SAPUI5 version 1.117.0

❯ ui5 add sap.ui.core sap.m themelib_sap_fiori_3
Updated configuration written to ui5.yaml
Expand All @@ -67,7 +67,7 @@ Build an optimized version of your project.

``` bash
❯ ui5 build
info graph:helpers:ui5Framework Using OpenUI5 version: 1.111.1
info graph:helpers:ui5Framework Using OpenUI5 version: 1.117.0
info ProjectBuilder Preparing build for project my-app
info ProjectBuilder Target directory: ./dist
info ProjectBuilder Cleaning target directory...
Expand Down
29 changes: 18 additions & 11 deletions docs/pages/Configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ See the list of [clients](https://github.com/redhat-developer/yaml-language-serv
## Example

```yaml
specVersion: "3.0"
specVersion: "3.1"
type: application|library|theme-library|module
metadata:
name: some.project.name
Expand All @@ -36,28 +36,28 @@ The type defines the default path mappings and build tasks. See [UI5 Builder: Ty
=== "application"

```yaml
specVersion: "3.0"
specVersion: "3.1"
type: application
```

=== "library"

```yaml
specVersion: "3.0"
specVersion: "3.1"
type: library
```

=== "theme-library"

```yaml
specVersion: "3.0"
specVersion: "3.1"
type: theme-library
```

=== "module"

```yaml
specVersion: "3.0"
specVersion: "3.1"
type: module
```

Expand Down Expand Up @@ -270,7 +270,7 @@ You can find an overview of the available versions for each framework here:
!!! example
=== "application"
```yaml
specVersion: "3.0"
specVersion: "3.1"
type: application
metadata:
name: my.company.app
Expand All @@ -286,7 +286,7 @@ You can find an overview of the available versions for each framework here:

=== "library"
```yaml
specVersion: "3.0"
specVersion: "3.1"
type: library
metadata:
name: my.company.library
Expand Down Expand Up @@ -618,20 +618,20 @@ The default and configured server ports can always be overwritten with the CLI p

!!! example
```yaml
specVersion: "3.0"
specVersion: "3.1"
type: application
metadata:
name: my.application
---
specVersion: "3.0"
specVersion: "3.1"
kind: extension
type: project-shim
metadata:
name: my.application.thirdparty
shims:
configurations:
lodash:
specVersion: "3.0"
specVersion: "3.1"
type: module
metadata:
name: lodash
Expand Down Expand Up @@ -718,7 +718,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 Tooling uses this information to detect whether the currently installed version is compatible to a project's configuration.

```yaml
specVersion: "3.0"
specVersion: "3.1"
[...]
```

Expand All @@ -737,6 +737,7 @@ Unless otherwise noted in the table below, UI5 Tooling modules are backward comp

Version | UI5 CLI Release
--- | ---
**3.1** | v3.5.0+
**3.0** | v3.0.0+
**2.6** | v2.14.0+
**2.5** | v2.12.0+
Expand All @@ -749,6 +750,12 @@ Version | UI5 CLI Release
**1.0** | v1.0.0+
**0.1** | v0.0.1+

### Specification Version 3.1

**Features:**

- Adds support for maintaining the [`builder.resources.excludes`](#exclude-resources) configuration for projects of type `module`

### Specification Version 3.0

**Breaking changes:**
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/OpenUI5.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ This configuration can be maintained by editing the file, or by using the UI5 CL

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

**Example ui5.yaml of a library**
```yaml
specVersion: "3.0"
specVersion: "3.1"
type: library
metadata:
name: some.library
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/SAPUI5.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ This configuration can be maintained by editing the file, or by using the UI5 CL

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

**Example ui5.yaml of a library**
```yaml
specVersion: "3.0"
specVersion: "3.1"
type: library
metadata:
name: some.library
Expand Down
8 changes: 4 additions & 4 deletions 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: "3.0"
specVersion: "3.1"
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: "3.0"
specVersion: "3.1"
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: "3.0"
specVersion: "3.1"
kind: project
type: application
metadata:
Expand All @@ -76,7 +76,7 @@ server:
beforeMiddleware: serveResources
---
# Custom middleware extension as part of your project
specVersion: "3.0"
specVersion: "3.1"
kind: extension
type: server-middleware
metadata:
Expand Down
10 changes: 5 additions & 5 deletions docs/pages/extensibility/CustomTasks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Another custom task called `renderMarkdownFiles` is then executed immediately af

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

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

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

```yaml
# Project configuration for the above example
specVersion: "3.0"
specVersion: "3.1"
kind: project
type: library
metadata:
Expand All @@ -93,7 +93,7 @@ builder:
firstH1IsTitle: true
---
# Task extension as part of your project
specVersion: "3.0"
specVersion: "3.1"
kind: extension
type: task
metadata:
Expand Down
22 changes: 11 additions & 11 deletions 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/SAP/ui5-tooling/blob/main/r

#### Structure
```yaml
specVersion: "3.0"
specVersion: "3.1"
kind: extension
type: project-shim
metadata:
name: <name of project shim extension>
shims:
configurations:
<module name (id)>:
specVersion: "3.0"
specVersion: "3.1"
type: <project type>
metadata:
name: <project name>
<module name (id)>:
specVersion: "3.0"
specVersion: "3.1"
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: "3.0"
specVersion: "3.1"
type: application
metadata:
name: my.application
--- # Everything below this line could also be put into the ui5.yaml of a standalone extension module
specVersion: "3.0"
specVersion: "3.1"
kind: extension
type: project-shim
metadata:
name: my.application.thirdparty
shims:
configurations:
lodash: # name as defined in package.json
specVersion: "3.0"
specVersion: "3.1"
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: "3.0"
specVersion: "3.1"
type: application
metadata:
name: application.a
----
specVersion: "3.0"
specVersion: "3.1"
kind: extension
type: project-shim
metadata:
name: legacy-lib-shims
shims:
configurations:
legacy-library-a:
specVersion: "3.0"
specVersion: "3.1"
type: library
metadata:
name: legacy.library.a
legacy-library-b:
specVersion: "3.0"
specVersion: "3.1"
type: library
metadata:
name: legacy.library.b
legacy-library-x:
specVersion: "3.0"
specVersion: "3.1"
type: library
metadata:
name: legacy.library.x
Expand Down