Skip to content

[INTERNAL] Docs: Use specVersion 1.0 #102

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 1 commit into from
Jan 15, 2019
Merged

[INTERNAL] Docs: Use specVersion 1.0 #102

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 5 additions & 5 deletions docs/BuildExtensibility.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ In the below example, when building the library `my.library` the `babel` task wi
````yaml
---
# In this example configuration two custom tasks are defined: 'babel' and 'generateMarkdownFiles'.
specVersion: "0.1"
specVersion: "1.0"
type: library
metadata:
name: my.library
Expand All @@ -36,7 +36,7 @@ You can also connect multiple custom task with each other. Please be aware that
````yaml
---
# In this example 'myCustomTask2' gets executed after 'myCustomTask1'.
specVersion: "0.1"
specVersion: "1.0"
type: library
metadata:
name: my.library
Expand All @@ -56,7 +56,7 @@ A custom task extension consists of a `ui5.yaml` and a [task implementation](#ta

````yaml
---
specVersion: "0.1"
specVersion: "1.0"
kind: extension
type: task
metadata:
Expand All @@ -76,7 +76,7 @@ The task extension will then be automatically collected and processed during the
````yaml
# ui5.yaml configuration for the above example

specVersion: "0.1"
specVersion: "1.0"
kind: project
type: library
metadata:
Expand All @@ -89,7 +89,7 @@ builder:
color: blue
---
# Task extension as part of your project
specVersion: "0.1"
specVersion: "1.0"
kind: extension
type: task
metadata:
Expand Down
26 changes: 13 additions & 13 deletions docs/Configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The preferred way of storing the configuration of a UI5 Build and Development To
**Example**
````yaml
---
specVersion: "0.1"
specVersion: "1.0"
type: application
metadata:
name: my-application
Expand All @@ -30,7 +30,7 @@ Configuration can also be supplied by other means. In cases where JSON is used,

````yaml
---
specVersion: "0.1"
specVersion: "1.0"
type: application|library|module
metadata:
name: testsuite
Expand Down Expand Up @@ -101,20 +101,20 @@ Also see [RFC 0002 Project Shims](https://github.com/SAP/ui5-tooling/blob/master

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

**ui5.yaml**
```yaml
specVersion: "0.1"
specVersion: "1.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: "0.1"
specVersion: "1.0"
kind: extension
type: project-shim
metadata:
name: my.application.thirdparty
shims:
configurations:
lodash: # name as defined in package.json
specVersion: "0.1"
specVersion: "1.0"
type: module # Use module type
metadata:
name: lodash
Expand Down Expand Up @@ -239,30 +239,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: "0.1"
specVersion: "1.0"
type: application
metadata:
name: application.a
----
specVersion: "0.1"
specVersion: "1.0"
kind: extension
type: project-shim
metadata:
name: legacy-lib-shims
shims:
configurations:
legacy-library-a:
specVersion: "0.1"
specVersion: "1.0"
type: library
metadata:
name: legacy.library.a
legacy-library-b:
specVersion: "0.1"
specVersion: "1.0"
type: library
metadata:
name: legacy.library.b
legacy-library-x:
specVersion: "0.1"
specVersion: "1.0"
type: library
metadata:
name: legacy.library.x
Expand Down