Skip to content

Commit da42f7e

Browse files
committed
[INTERNAL] Update links after code-split / main to v4 branch rename
1 parent 8838f5e commit da42f7e

File tree

11 files changed

+32
-32
lines changed

11 files changed

+32
-32
lines changed

.github/ISSUE_TEMPLATE/bug-report.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ assignees: ''
1010

1111
<!--
1212
Hey there 👋 Please have a look at our guidelines on reporting issues:
13-
https://github.com/UI5/cli/blob/main/CONTRIBUTING.md#-reporting-issues
13+
https://github.com/UI5/cli/blob/v4/CONTRIBUTING.md#-reporting-issues
1414
1515
Please use this template and replace as many "{...}" and "unknown" as possible.
1616
Thank you 🧡

.github/ISSUE_TEMPLATE/feature-request.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ assignees: ''
99

1010
<!--
1111
Hey there 👋 Please also have a look at our guidelines on feature requests:
12-
https://github.com/UI5/cli/blob/main/CONTRIBUTING.md#-feature-requests
12+
https://github.com/UI5/cli/blob/v4/CONTRIBUTING.md#-feature-requests
1313
-->
1414

1515
## Is your feature request related to a problem? Please describe.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
To get it merged faster, kindly review the checklist below:
44

55
## Pull Request Checklist
6-
- [ ] Reviewed the [Contributing Guidelines](https://github.com/UI5/cli/blob/main/CONTRIBUTING.md#-contributing-code)
7-
+ Especially the [How to Contribute](https://github.com/UI5/cli/blob/main/CONTRIBUTING.md#how-to-contribute) section
8-
- [ ] [No merge commits](https://github.com/UI5/cli/blob/main/docs/Guidelines.md#no-merge-commits)
9-
- [ ] [Correct commit message style](https://github.com/UI5/cli/blob/main/docs/Guidelines.md#commit-message-style)
6+
- [ ] Reviewed the [Contributing Guidelines](https://github.com/UI5/cli/blob/v4/CONTRIBUTING.md#-contributing-code)
7+
+ Especially the [How to Contribute](https://github.com/UI5/cli/blob/v4/CONTRIBUTING.md#how-to-contribute) section
8+
- [ ] [No merge commits](https://github.com/UI5/cli/blob/v4/docs/Guidelines.md#no-merge-commits)
9+
- [ ] [Correct commit message style](https://github.com/UI5/cli/blob/v4/docs/Guidelines.md#commit-message-style)

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,4 +134,4 @@ There are phases when development of a new major version of UI5 CLI has already
134134
### Contributing with AI-generated code
135135
As artificial intelligence evolves, AI-generated code is becoming valuable for many software projects, including open-source initiatives. While we recognize the potential benefits of incorporating AI-generated content into our open-source projects there are certain requirements that need to be reflected and adhered to when making contributions.
136136

137-
Please see our [guideline for AI-generated code contributions to SAP Open Source Software Projects](https://github.com/SAP/.github/blob/main/CONTRIBUTING_USING_GENAI.md) for these requirements.
137+
Please see our [guideline for AI-generated code contributions to SAP Open Source Software Projects](https://github.com/UI5/.github/blob/main/CONTRIBUTING_USING_GENAI.md) for these requirements.

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
- [Project Configuration](https://ui5.github.io/cli/v3/pages/Configuration/)
2525
- 🎬 [UI5con@SAP 2020 Talk](https://www.youtube.com/watch?v=8IHoVJLKN34)
2626
- 🎬 [UI5con@SAP 2018 Talk](https://www.youtube.com/watch?v=iQ07oe26y_k)
27-
- [Contribution Guidelines](https://github.com/UI5/cli/blob/main/CONTRIBUTING.md)
27+
- [Contribution Guidelines](https://github.com/UI5/cli/blob/v4/CONTRIBUTING.md)
2828
- [Roadmap](https://github.com/UI5/cli/issues/701)
2929

3030
## Modules
@@ -43,8 +43,8 @@ UI5 CLI consists of multiple modules. Each one is managed in a separate reposito
4343

4444
## Contributing
4545

46-
Please check our [Contribution Guidelines](https://github.com/UI5/cli/blob/main/CONTRIBUTING.md).
46+
Please check our [Contribution Guidelines](https://github.com/UI5/cli/blob/v4/CONTRIBUTING.md).
4747

4848
## Support
4949

50-
Please follow our [Contribution Guidelines](https://github.com/UI5/cli/blob/main/CONTRIBUTING.md#report-an-issue) on how to report an issue. Or chat with us in the [`#tooling`](https://openui5.slack.com/archives/C0A7QFN6B) channel of the [OpenUI5 Community Slack](https://ui5-slack-invite.cfapps.eu10.hana.ondemand.com). For public Q&A, use the [`ui5-tooling` tag on Stack Overflow](https://stackoverflow.com/questions/tagged/ui5-tooling).
50+
Please follow our [Contribution Guidelines](https://github.com/UI5/cli/blob/v4/CONTRIBUTING.md#report-an-issue) on how to report an issue. Or chat with us in the [`#tooling`](https://openui5.slack.com/archives/C0A7QFN6B) channel of the [OpenUI5 Community Slack](https://ui5-slack-invite.cfapps.eu10.hana.ondemand.com). For public Q&A, use the [`ui5-tooling` tag on Stack Overflow](https://stackoverflow.com/questions/tagged/ui5-tooling).

SUPPORT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ Instead, please use one of the following platforms to seek help:
77
* [StackOverflow](http://stackoverflow.com/questions/tagged/ui5-tooling)
88
* The [`#tooling`](https://openui5.slack.com/archives/C0A7QFN6B) channel of the [OpenUI5 Community Slack](https://ui5-slack-invite.cfapps.eu10.hana.ondemand.com).
99

10-
If you want to report an issue or request a new feature, please follow our [Contribution Guidelines](https://github.com/UI5/cli/blob/main/CONTRIBUTING.md#-feature-requests).
10+
If you want to report an issue or request a new feature, please follow our [Contribution Guidelines](https://github.com/UI5/cli/blob/v4/CONTRIBUTING.md#-feature-requests).

docs/indexJsdoc.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# UI5 CLI API Reference
22

33
## Support
4-
Please follow our [Contribution Guidelines](https://github.com/UI5/cli/blob/main/CONTRIBUTING.md#report-an-issue) on how to report an issue. Or chat with us in the [`#tooling`](https://openui5.slack.com/archives/C0A7QFN6B) channel of the [OpenUI5 Community Slack](https://ui5-slack-invite.cfapps.eu10.hana.ondemand.com)
4+
Please follow our [Contribution Guidelines](https://github.com/UI5/cli/blob/v4/CONTRIBUTING.md#report-an-issue) on how to report an issue. Or chat with us in the [`#tooling`](https://openui5.slack.com/archives/C0A7QFN6B) channel of the [OpenUI5 Community Slack](https://ui5-slack-invite.cfapps.eu10.hana.ondemand.com)
55

66
## License
7-
This project is licensed under the Apache Software License, Version 2.0 except as noted otherwise in the [LICENSE](https://github.com/UI5/cli/blob/main/LICENSE.txt) file.
7+
This project is licensed under the Apache Software License, Version 2.0 except as noted otherwise in the [LICENSE](https://github.com/UI5/cli/blob/v4/LICENSE.txt) file.

docs/pages/CodeAnalysis.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ The following APIs are analyzed by the JSModule Analyzer:
2727
- sap.ui.preload (restricted)
2828
- sap.ui.require.preload (restricted)
2929

30-
The [JSModule Analyzer](https://github.com/SAP/ui5-builder/blob/main/lib/lbt/analyzer/JSModuleAnalyzer.js) uses the ["Abstract Syntax Tree"](https://en.wikipedia.org/wiki/Abstract_syntax_tree) (AST) of a JavaScript file to decide whether a code block is executed *conditionally* or *unconditionally*.
30+
The [JSModule Analyzer](https://github.com/SAP/ui5-builder/blob/v4/lib/lbt/analyzer/JSModuleAnalyzer.js) uses the ["Abstract Syntax Tree"](https://en.wikipedia.org/wiki/Abstract_syntax_tree) (AST) of a JavaScript file to decide whether a code block is executed *conditionally* or *unconditionally*.
3131

3232
The analyzer uses a set of rules to decide whether one of the above APIs is called whenever the module is executed or whether the API is only called under certain conditions.
3333

@@ -41,7 +41,7 @@ When a dependency in one of the mentioned APIs is not a "simple literal" but an
4141

4242
### Component Analyzer
4343

44-
The [Component Analyzer](https://github.com/SAP/ui5-builder/blob/main/lib/lbt/analyzer/ComponentAnalyzer.js) analyzes JavaScript files named `Component.js` to collect dependency information by searching for a `manifest.json` located in the same folder as the `Component.js`. If one is found, the `sap.ui5` section is evaluated in the following way:
44+
The [Component Analyzer](https://github.com/SAP/ui5-builder/blob/v4/lib/lbt/analyzer/ComponentAnalyzer.js) analyzes JavaScript files named `Component.js` to collect dependency information by searching for a `manifest.json` located in the same folder as the `Component.js`. If one is found, the `sap.ui5` section is evaluated in the following way:
4545

4646
- Any library dependency is added as a dependency to the `library.js` module of that library. If the library dependency is modeled as 'lazy', the
4747
module dependency will be added as 'conditional'.
@@ -51,7 +51,7 @@ The [Component Analyzer](https://github.com/SAP/ui5-builder/blob/main/lib/lbt/an
5151

5252
### Smart Template Analyzer
5353

54-
The [Smart Template Analyzer](https://github.com/SAP/ui5-builder/blob/main/lib/lbt/analyzer/SmartTemplateAnalyzer.js) analyzes a Smart Template app and its underlying template components to collect dependency information. It searches for a `manifest.json` located in the same folder as the `Component.js`. If it is found and if it is valid JSON, an `sap.ui.generic.app` section is searched and evaluated in the following way:
54+
The [Smart Template Analyzer](https://github.com/SAP/ui5-builder/blob/v4/lib/lbt/analyzer/SmartTemplateAnalyzer.js) analyzes a Smart Template app and its underlying template components to collect dependency information. It searches for a `manifest.json` located in the same folder as the `Component.js`. If it is found and if it is valid JSON, an `sap.ui.generic.app` section is searched and evaluated in the following way:
5555

5656
- For each page configuration, the configured component is added as a dependency to the template app module.
5757
- If the page configuration contains a `templateName`, a dependency to that template view is added to the app.
@@ -71,7 +71,7 @@ The manifest of the template app could in theory specify an alternative template
7171

7272
### XML Template Analyzer
7373

74-
The [XML Template Analyzer](https://github.com/SAP/ui5-builder/blob/main/lib/lbt/analyzer/XMLTemplateAnalyzer.js) tackles `XMLView` and `XMLFragment`. It parses the XML, collects controls, and adds them as dependency to the ModuleInfo object.
74+
The [XML Template Analyzer](https://github.com/SAP/ui5-builder/blob/v4/lib/lbt/analyzer/XMLTemplateAnalyzer.js) tackles `XMLView` and `XMLFragment`. It parses the XML, collects controls, and adds them as dependency to the ModuleInfo object.
7575
Additionally, some special dependencies are handled:
7676

7777
- controller of the view
@@ -86,7 +86,7 @@ For example, if the qualified node name is `sap.m.Text`, the analyzer checks whe
8686

8787
The **XMLComposite** control is deprecated since version UI5 1.88. Nevertheless, UI5 CLI will attempt to analyze the declaration of any such controls in a project.
8888

89-
The [XML Composite Analyzer](https://github.com/SAP/ui5-builder/blob/main/lib/lbt/analyzer/XMLCompositeAnalyzer.js) searches for the name of the configured fragment containing the **XMLComposite** control.
89+
The [XML Composite Analyzer](https://github.com/SAP/ui5-builder/blob/v4/lib/lbt/analyzer/XMLCompositeAnalyzer.js) searches for the name of the configured fragment containing the **XMLComposite** control.
9090

9191
=== "Name of the XMLComposite is equal to fragment name"
9292

@@ -112,7 +112,7 @@ The [XML Composite Analyzer](https://github.com/SAP/ui5-builder/blob/main/lib/lb
112112

113113
## Library Initialization
114114

115-
The [library.js Analyzer](https://github.com/SAP/ui5-builder/blob/main/lib/lbt/analyzer/analyzeLibraryJS.js) checks every `library.js` file in the namespace of a library for occurences of a `sap/ui/core/Core#initLibrary` call. If found, the following information will be placed in the generated manifest.json:
115+
The [library.js Analyzer](https://github.com/SAP/ui5-builder/blob/v4/lib/lbt/analyzer/analyzeLibraryJS.js) checks every `library.js` file in the namespace of a library for occurences of a `sap/ui/core/Core#initLibrary` call. If found, the following information will be placed in the generated manifest.json:
116116

117117
- noLibraryCSS: false when the noLibraryCSS property had been set in the initLibrary info object
118118
- types: string array with the names of the types contained in the library
@@ -130,22 +130,22 @@ The UI5 CLI offers a JSDoc build, which is enhanced by UI5-specific JSDoc featur
130130

131131
An UI5 SDK can be built locally. To get more insight into the local UI5 SDK build setup, have a look at our [Developer's Guide](https://github.com/SAP/openui5/blob/-/docs/developing.md#building-the-openui5-sdk-demo-kit).
132132

133-
Currently, the resources needed for a UI5 SDK build are stored in [openui5](https://github.com/SAP/openui5/tree/-/lib/jsdoc) and in [ui5-builder](https://github.com/SAP/ui5-builder/blob/main/lib/processors/jsdoc). This double maintenance is needed because these files are not part of the `sap.ui.core` library artefact, so building JSDoc for any library has no access to the needed resources. It's therefore necessary to have these resources also available in the *ui5-builder*. This might change in the future.
133+
Currently, the resources needed for a UI5 SDK build are stored in [openui5](https://github.com/SAP/openui5/tree/-/lib/jsdoc) and in [ui5-builder](https://github.com/SAP/ui5-builder/blob/v4/lib/processors/jsdoc). This double maintenance is needed because these files are not part of the `sap.ui.core` library artefact, so building JSDoc for any library has no access to the needed resources. It's therefore necessary to have these resources also available in the *ui5-builder*. This might change in the future.
134134

135135
The following artefacts contribute to the JSDoc build:
136136

137-
- [jsdocGenerator.js](https://github.com/SAP/ui5-builder/blob/main/lib/processors/jsdoc/jsdocGenerator.js):
137+
- [jsdocGenerator.js](https://github.com/SAP/ui5-builder/blob/v4/lib/processors/jsdoc/jsdocGenerator.js):
138138
Executes the actual JSDoc build. UI5 CLI wrapper for `plugin.cjs`.
139-
- [sdkTransformer.js](https://github.com/SAP/ui5-builder/blob/main/lib/processors/jsdoc/sdkTransformer.js):
139+
- [sdkTransformer.js](https://github.com/SAP/ui5-builder/blob/v4/lib/processors/jsdoc/sdkTransformer.js):
140140
UI5 CLI wrapper for `transformApiJson.cjs`.
141-
- [apiIndexGenerator.js](https://github.com/SAP/ui5-builder/blob/main/lib/processors/jsdoc/apiIndexGenerator.js):
141+
- [apiIndexGenerator.js](https://github.com/SAP/ui5-builder/blob/v4/lib/processors/jsdoc/apiIndexGenerator.js):
142142
UI5 CLI wrapper for `createIndexFiles.cjs`.
143-
- [createIndexFiles.cjs](https://github.com/SAP/ui5-builder/blob/main/lib/processors/jsdoc/lib/createIndexFiles.cjs):
143+
- [createIndexFiles.cjs](https://github.com/SAP/ui5-builder/blob/v4/lib/processors/jsdoc/lib/createIndexFiles.cjs):
144144
Creates API index resources from all `api.json` resources and by interpreting the `sap-ui-version.json` available in the given test resources directory. The resulting index resources (e.g. `api-index.json`, `api-index-deprecated.json`,
145145
`api-index-experimental.json` and `api-index-since.json`) are only to be used in a UI5 SDK.
146-
- [transformApiJson.cjs](https://github.com/SAP/ui5-builder/blob/main/lib/processors/jsdoc/lib/transformApiJson.cjs):
146+
- [transformApiJson.cjs](https://github.com/SAP/ui5-builder/blob/v4/lib/processors/jsdoc/lib/transformApiJson.cjs):
147147
Preprocesses `api.json` files for use in UI5 SDKs. Transforms the `api.json` as created by the JSDoc build into a pre-processed `api.json` file suitable for the SDK. The pre-processing includes formatting of type references, rewriting of links, and other time-consuming calculations.
148-
- [plugin.cjs](https://github.com/SAP/ui5-builder/blob/main/lib/processors/jsdoc/lib/ui5/plugin.cjs):
148+
- [plugin.cjs](https://github.com/SAP/ui5-builder/blob/v4/lib/processors/jsdoc/lib/ui5/plugin.cjs):
149149
UI5 plugin for JSDoc3. The plugin adds the following UI5-specific tag definitions to JSDoc3:
150150

151151
- disclaimer
@@ -165,7 +165,7 @@ The following artefacts contribute to the JSDoc build:
165165

166166
Last but not least, it implements an astNodeVisitor to detect UI5-specific "extend" calls and to create documentation for the properties, aggregations, etc. that are created with the "extend" call.
167167

168-
- [publish.cjs](https://github.com/SAP/ui5-builder/blob/main/lib/processors/jsdoc/lib/ui5/template/publish.cjs): JSDoc3 template for UI5 documentation generation.
168+
- [publish.cjs](https://github.com/SAP/ui5-builder/blob/v4/lib/processors/jsdoc/lib/ui5/template/publish.cjs): JSDoc3 template for UI5 documentation generation.
169169

170170
- adds missing namespaces
171171
- determines the export names of exported APIs
@@ -174,4 +174,4 @@ The following artefacts contribute to the JSDoc build:
174174
- checks for cyclic dependencies
175175
- removes unnecessary whitespace from an HTML document
176176

177-
- [versionUtil.cjs](https://github.com/SAP/ui5-builder/blob/main/lib/processors/jsdoc/lib/ui5/template/utils/versionUtil.cjs): Provides helper methods to determine version-related information.
177+
- [versionUtil.cjs](https://github.com/SAP/ui5-builder/blob/v4/lib/processors/jsdoc/lib/ui5/template/utils/versionUtil.cjs): Provides helper methods to determine version-related information.

docs/pages/FAQ.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# FAQ
22
### How Can I Contribute?
3-
Please check our [Contribution Guidelines](https://github.com/UI5/cli/blob/main/CONTRIBUTING.md).
3+
Please check our [Contribution Guidelines](https://github.com/UI5/cli/blob/v4/CONTRIBUTING.md).
44

55
### How Can I Obtain Support?
6-
Please follow our [Contribution Guidelines](https://github.com/UI5/cli/blob/main/CONTRIBUTING.md#report-an-issue) on how to report an issue.
6+
Please follow our [Contribution Guidelines](https://github.com/UI5/cli/blob/v4/CONTRIBUTING.md#report-an-issue) on how to report an issue.
77

88
### What's the Difference Between OpenUI5 and SAPUI5?
99
The open source project [OpenUI5](https://openui5.org/) provides most of the fundamental framework features. [SAPUI5](https://ui5.sap.com/) enhances this by providing **additional libraries** under a **different license**.

docs/pages/Troubleshooting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ An HTTPS server or proxy that was previously running on a domain (e.g. `localhos
77
You need to delete the HSTS mapping in [chrome://net-internals/#hsts](chrome://net-internals/#hsts) by entering the domain name (e.g. `localhost`) and pressing "delete".
88

99
## Issues Not Listed Here
10-
Please follow our [Contribution Guidelines](https://github.com/UI5/cli/blob/main/CONTRIBUTING.md#report-an-issue) on how to report an issue.
10+
Please follow our [Contribution Guidelines](https://github.com/UI5/cli/blob/v4/CONTRIBUTING.md#report-an-issue) on how to report an issue.
1111

1212
## UI5 Project
1313
### `~/.ui5` Taking too Much Disk Space

0 commit comments

Comments
 (0)