Skip to content

Commit

Permalink
Add documentation about Build Extensibility
Browse files Browse the repository at this point in the history
  • Loading branch information
devtomtom committed Dec 4, 2018
1 parent 8873135 commit 598d41f
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 12 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
![UI5 icon](https://raw.githubusercontent.com/SAP/ui5-tooling/master/docs/images/UI5_logo_wide.png)

# ui5-project
> Modules for building a UI5 projects dependency tree, including configuration
> Modules for building a UI5 projects dependency tree, including configuration
> Part of the [UI5 Build and Development Tooling](https://github.com/SAP/ui5-tooling)
[![Travis CI Build Status](https://travis-ci.org/SAP/ui5-project.svg?branch=master)](https://travis-ci.org/SAP/ui5-project)
Expand All @@ -10,7 +10,7 @@
[![Dependency Status](https://david-dm.org/SAP/ui5-project/master.svg)](https://david-dm.org/SAP/ui5-project/master)
[![devDependency Status](https://david-dm.org/SAP/ui5-project/master/dev-status.svg)](https://david-dm.org/SAP/ui5-project/master#info=devDependencies)

**This is an alpha release!**
**This is an alpha release!**
**The UI5 Build and Development Tooling described here is not intended for productive use yet. Breaking changes are to be expected.**

## Normalizer
Expand Down Expand Up @@ -65,7 +65,7 @@ The npm translator is currently the default translator and looks for dependencie

Can be used to supply the full dependency information of a project in a single structured file.

Usage example: `ui5 serve -b static:/path/to/projectDependencies.yaml`
Usage example: `ui5 serve -b static:/path/to/projectDependencies.yaml`
`projectDependencies.yaml` contains something like:
````yaml
---
Expand Down Expand Up @@ -214,14 +214,14 @@ resources:
"src": "source"
builder:
customTasks:
- name: <custom-task-name-1>
beforeTask: <standard-task-name>
- name: custom-task-name-1
beforeTask: standard-task-name
configuration:
color: blue
- name: <custom-task-name-2>
afterTask: <custom-task-name-1>
configuration-key: value
- name: custom-task-name-2
afterTask: custom-task-name-1
configuration:
color: red
configuration-key: value
server:
settings:
port: 8099
Expand All @@ -246,7 +246,7 @@ Some general information

##### builder (optional)

- `customTasks` (optional, list): in this block you can define additional custom build tasks. Please see (here) for a detailed explanation and examples of the build extensibility. Each entry in the `customTasks` list consists of the following options:
- `customTasks` (optional, list): in this block you can define additional custom build tasks. Please see ([here](docs/BuildExtensibility.md)) for a detailed explanation and examples of the build extensibility. Each entry in the `customTasks` list consists of the following options:
- `name` (mandatory): the name of the custom task
- `afterTask` or `beforeTask` (only one, mandatory): the name of the build task after or before which your custom task will be executed.
- `configuration` (optional): additional configuration for your custom build task
Expand Down
4 changes: 2 additions & 2 deletions docs/BuildExtensibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,11 @@ builder:
color: blue
````

In the above example, when building the library `my.library` the `babel` task will be executed before the standard task `generateComponentPreload`. Another custom task called `generateMarkdownFiles` is then executed immediatly after the standard task `ugilfy`.
In the above example, when building the library `my.library` the `babel` task will be executed before the standard task `generateComponentPreload`. Another custom task called `generateMarkdownFiles` is then executed immediatly after the standard task `uglify`.

### Example: Connect multiple custom tasks

You can also connect multiple custom task with eachother. If you do, please be aware that the order of your definitions is important. You have to make sure that the task is defined before you set it as `beforeTask` or `afterTask`.
You can also connect multiple custom task with each other. If you do, please be aware that the order of your definitions is important. You have to make sure that the task is defined before you set it as `beforeTask` or `afterTask`.

````yaml
---
Expand Down

0 comments on commit 598d41f

Please sign in to comment.