feat!: Disable generation of library manifest - #1533
Conversation
|
Hi @KlattG Would you take a look at the modified docs:
Cheers |
| /** | ||
| * Task for creating a library manifest.json from its .library file. | ||
| * | ||
| * **Note:** This task is not executed for projects using Specification Version 5.0 or higher. |
There was a problem hiding this comment.
The task itself is independent from the decision not to run it in certain scenarios. If you call it directly, you can execute it for a library project with specVersion 5.0 or higher. Same as we will still call it for the framework libraries.
As the task itself stays independent, I would not mention anything in this JSDoc here.
| <sup>5</sup> Can be enabled for framework projects via the `includeTask` option. For other projects, this task is skipped | ||
| <sup>6</sup> Disabled for the server due to a corresponding middleware producing the same output | ||
| <sup>6</sup> Disabled for the server due to a corresponding middleware producing the same output | ||
| <sup>7</sup> Enabled for Specification Version 4.0 and lower. Not executed for Specification Version 5.0 and higher — libraries must provide a `manifest.json` in their source directory |
There was a problem hiding this comment.
This note is missing to explain the exception for framework projects (similar to <sup>5</sup>)
|
|
||
| ## Breaking Changes | ||
|
|
||
| - **@ui5/builder: `generateLibraryManifest` task is not executed for Specification Version 5.0** |
There was a problem hiding this comment.
I'm not sure whether this change is a breaking change of @ui5/builder, especially as the PR only adds JSDoc comments to files in the builder package, but does not adjust any code.
In addition, I'm also not sure whether this PR is a breaking change in general. It is a breaking change that comes with specVersion 5.0, but not a change that needs adjustment by consumers, unless they upgrade to specVersion 5.0. This is an important difference which allows us to make sure changes without disrupt existing projects.
|
|
||
| ## generateLibraryManifest Task No Longer Executed | ||
|
|
||
| With **Specification Version 5.0**, the [`generateLibraryManifest`](../api/module-@ui5_builder_tasks_generateLibraryManifest) build task is no longer executed. Libraries must provide a `manifest.json` directly in their source directory. |
There was a problem hiding this comment.
Should we also mention the breaking change in the Specification Version documentation at internal/documentation/docs/pages/Configuration.md ?
2 participants
JIRA: CPOUI5FOUNDATION-1156
BREAKING CHANGE: The
generateLibraryManifestbuild task is no longer executed for library projects using Specification Version 5.0 or higher. Libraries must provide amanifest.jsondirectly in their source directory.The behavior for Specification Version 4.0 and lower is unchanged.