-
Notifications
You must be signed in to change notification settings - Fork 75
[INTERNAL] Add preliminary guide for v3 migration #608
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.
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
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
74a8f98
[INTERNAL] Add preliminary guide for v3 migration
matz3 7276773
Add Source Maps section in Builder page
matz3 5619c60
Add info about v3 development and how to install
matz3 568c732
Apply suggestions from code review
matz3 aa8b33c
Apply same suggestion to Builder.md
matz3 7eb2369
Add link to Source Maps PR
matz3 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| # Migrate to v3 | ||
|
|
||
| !!! warning | ||
| UI5 Tooling v3 is currently in development. Further breaking changes are expected. | ||
| The latest development version can be installed via `npm i -D @ui5/cli@next` | ||
|
|
||
| ## Breaking changes | ||
|
|
||
| **All UI5 Tooling Modules Require Node.js >= 16.13.2 / npm >= 8** | ||
|
|
||
| Support for older Node.js and npm releases has been dropped. | ||
| Only Node.js v16.13.2 and npm v8 or higher are supported. | ||
|
|
||
| **Removal of tasks and processors** | ||
|
|
||
| The following tasks have been removed: | ||
|
|
||
| - createDebugFiles | ||
| - uglify | ||
|
|
||
| The following processors have been removed: | ||
|
|
||
| - debugFileCreator | ||
| - resourceCopier | ||
| - uglifier | ||
|
|
||
| As a replacement, the new 'minify' task and 'minifier' processor can be | ||
| used. | ||
|
|
||
| Note: The minify task is executed earlier, before the bundling | ||
| process takes place. Any existing 'beforeTask' or 'afterTask' configuration of | ||
| custom tasks might need to be adapted to cater for this change. | ||
|
|
||
| Updated list of standard tasks: | ||
|
|
||
| | Task | Type `application` | Type `library` | Type `theme-library` | | ||
| | ---- | :----: | :----: | :----: | | ||
| | escapeNonAsciiCharacters | {: .sap-icon-circle-task-2 } | {: .sap-icon-circle-task-2 } | | | ||
| | replaceCopyright | {: .sap-icon-circle-task-2 } | {: .sap-icon-circle-task-2 } | {: .sap-icon-circle-task-2 } | | ||
| | replaceVersion | {: .sap-icon-circle-task-2 } | {: .sap-icon-circle-task-2 } | {: .sap-icon-circle-task-2 } | | ||
| | replaceBuildtime | | {: .sap-icon-circle-task-2 } | | | ||
| | generateJsdoc | | {: .sap-icon-circle-task }^1^ | | | ||
| | executeJsdocSdkTransformation | | {: .sap-icon-circle-task }^1^ | | | ||
| | generateFlexChangesBundle | | {: .sap-icon-circle-task-2 } | | | ||
| | generateManifestBundle | {: .sap-icon-circle-task } | {: .sap-icon-circle-task } | | | ||
| | **ADDED:** minify | {: .sap-icon-circle-task } | {: .sap-icon-circle-task } | | | ||
| | generateLibraryManifest | | {: .sap-icon-circle-task-2 } | | | ||
| | generateLibraryPreload | | {: .sap-icon-circle-task-2 } | | | ||
| | generateComponentPreload | {: .sap-icon-circle-task-2 } | {: .sap-icon-circle-task }^2^ | | | ||
| | generateStandaloneAppBundle | {: .sap-icon-circle-task }^3^ | | | | ||
| | transformBootstrapHtml | {: .sap-icon-circle-task }^3^ | | | | ||
| | generateBundle | {: .sap-icon-circle-task }^4^ | {: .sap-icon-circle-task }^4^ | | | ||
| | buildThemes | | {: .sap-icon-circle-task-2 } | {: .sap-icon-circle-task-2 } | | ||
| | generateThemeDesignerResources | | {: .sap-icon-circle-task } | {: .sap-icon-circle-task } | | ||
| | **REMOVED:** ~~createDebugFiles~~ | | | | | ||
| | **REMOVED:** ~~uglify~~ | | | | | ||
| | generateVersionInfo | {: .sap-icon-circle-task-2 } | | | | ||
| | generateCachebusterInfo | {: .sap-icon-circle-task } | | | | ||
| | generateApiIndex | {: .sap-icon-circle-task }^1^ | | | | ||
| | generateResourcesJson | {: .sap-icon-circle-task } | {: .sap-icon-circle-task } | {: .sap-icon-circle-task } | | ||
|
|
||
| *Enabled by default* | ||
| {: .sap-icon-circle-task-2-before } | ||
|
|
||
| *Disabled by default. Can be activated by certain build modes, the project configuration, or by using the `--include-task` [CLI parameter](../pages/CLI.md#ui5-build). See footnotes where given* | ||
| {: .sap-icon-circle-task-before } | ||
|
|
||
| --- | ||
|
|
||
| ^1^ Enabled in `jsdoc` build, which disables most of the other tasks | ||
| ^2^ Enabled for projects defining a [component preload configuration](../pages/Configuration.md#component-preload-generation) | ||
| ^3^ Enabled in `self-contained` build, which disables `generateComponentPreload` and `generateLibraryPreload` | ||
| ^4^ Enabled for projects defining a [bundle configuration](../pages/Configuration.md#custom-bundling) |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.