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 docs: Add builder resource excludes #180

Merged
merged 4 commits into from
Jun 4, 2019
Merged

[INTERNAL] Configuration docs: Add builder resource excludes #180

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
72c4301
[INTERNAL] Configuration docs: Add various resource excludes
RandomByte Mar 13, 2019
793a796
Remove general exclude configuration and refine documentation
RandomByte May 28, 2019
3e318db
Clarify how glob patterns are applied
RandomByte May 29, 2019
bae953e
Put globs into strings
RandomByte Jun 4, 2019
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
16 changes: 13 additions & 3 deletions docs/Configuration.md
View file
Open in desktop
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