Skip to content

Commit

Permalink
[INTERNAL] Configuration docs: Add various resource excludes (#180)
Browse files Browse the repository at this point in the history
  • Loading branch information
RandomByte committed Jun 4, 2019
1 parent a5dc1d0 commit b4561f2
Showing 1 changed file with 13 additions and 3 deletions.
16 changes: 13 additions & 3 deletions docs/Configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,14 @@ builder:
afterTask: custom-task-name-1
configuration:
color: blue
resources:
excludes:
- "/resources/some/project/name/test_results/**"
- "/test-resources/**"
- "!/test-resources/some/project/name/demo-app/**"
jsdoc:
excludes:
- some/project/name/thirdparty/**
- "some/project/name/thirdparty/**"
server:
settings:
port: 8099
Expand Down Expand Up @@ -84,12 +89,17 @@ Some general information:
It is recommended that modules include their namespace in the virtual path and use the `/resources` prefix (e.g. `/resources/my/first/library/module-xy`).

#### builder (optional)
- `resources`: General resource configuration for this project
- `excludes`: List of glob patterns. Matching resources of this project will be ignored by the builder (i.e. all tasks).
Patterns are applied to the **virtual** path of resources (i.e. the UI5 runtime paths). Exclude patterns are always applied after any includes.
- `jsdoc`: Configuration specific to the JSDoc build task
- `excludes`: List of glob patterns. Matching resources will be ignored by the JSDoc build task.
Patterns are always applied relative to the projects virtual **source** directory `/resources/`.
Any general builder excludes (as defined in `builder.resources.excludes`) are applied *after* these excludes.
- `customTasks` (optional, list): In this block, you define additional custom build tasks, see [here](./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 that is passed to the custom build task
- `jsdoc`
- `excludes`: List of glob patterns. Matching resources will be ignored from the JSDoc build

#### server (optional)
- `settings` (not yet implemented)
Expand Down

0 comments on commit b4561f2

Please sign in to comment.