|
1 |
| -# abap2UI5 with Renamed Namespace |
| 1 | +# abap2UI5-builder |
2 | 2 |
|
3 |
| -This repository demonstrates the automagic namespace renaming functionality. Fork this repository and automatically rename the namespace of abap2UI5. |
| 3 | +Automatically create your own abap2UI5 build. Choose your language version and the addons you need. |
4 | 4 |
|
5 |
| -### Features |
6 |
| -* create a version for your customer namespace, e.g., /YYY/u5 or /YYY/2ui5. |
7 |
| -* create versions for different departments, e.g., z2ui5_mm, z2ui5_pp, etc. |
8 |
| -* create release-specific versions, e.g., z2ui5_124, z2ui5_125, etc. |
| 5 | +Features: |
| 6 | +* Integrates abap2UI5, frontend, and multiple addons into a single project |
| 7 | +* Rename all artifacts to your custom namespace |
| 8 | +* Supports running multiple builds on the same system |
| 9 | +* Install your new build with a single abapGit pull |
9 | 10 |
|
10 |
| -After renaming, you can install abap2UI5 multiple times in the same system. |
| 11 | +Find default builds for various use cases [here.](https://github.com/abap2UI5/build) |
11 | 12 |
|
12 |
| -### Usage |
13 |
| -1. Fork this repository |
14 |
| -2. Set your new namespace [here](https://github.com/abap2UI5/abap2UI5-mirror-renamed/blob/main/abaplint_rename.json#L16-L17) |
15 |
| -3. Run `npm run init` and `npm run main` to mirror [abap2UI5](https://github.com/abap2UI5/abap2UI5) and rename for example `z2ui5` to `/2U5/TEST` |
16 |
| -4. Pull the repository with abapGit |
17 |
| -5. (Optional) setup a [github action](https://github.com/abap2UI5/abap2UI5-mirror-renamed/blob/main/.github/workflows/cron.yml) to automate this process |
| 13 | +### Build Process |
| 14 | +1. Fork this repository and adjust the configuration for your build process [here:](https://github.com/abap2UI5/builder/blob/main/build/build.jsonc) |
| 15 | +```json |
| 16 | +{ |
| 17 | + "abap_version": "Cloud", |
| 18 | + "repositories": [ |
| 19 | + "abap2UI5", |
| 20 | + "layout-variant-management", |
| 21 | + "table-maintenance" |
| 22 | + ] |
| 23 | +} |
| 24 | +``` |
| 25 | +Run the clone process: |
| 26 | +``` |
| 27 | +npm run clone |
| 28 | +``` |
| 29 | +2. (optional) Adjust the configuration for your rename process [here](https://github.com/abap2UI5/builder/blob/main/build/rename.jsonc) and run it with: |
18 | 30 |
|
19 |
| -### Credits |
20 |
| -Thank you to [larshp](https://github.com/larshp) and the tool abaplint processing the renaming and [christianguenter2](https://github.com/christianguenter2) for abap2UI5 adjustments. |
| 31 | +``` |
| 32 | +npm run rename |
| 33 | +``` |
| 34 | +3. (optional) Add abaplint static code check [here:](https://github.com/abap2UI5/builder/blob/main/build/abaplint.jsonc) |
| 35 | +``` |
| 36 | +npm run abaplint |
| 37 | +``` |
| 38 | +4. Find your newly generated abapGit project in the `dist` folder. Create a new build branch with: |
| 39 | +``` |
| 40 | +npm run branch |
| 41 | +``` |
| 42 | +5. Pull this branch to your ABAP system, and you're ready to go. |
| 43 | + |
| 44 | +### Automate with GitHub Actions |
| 45 | +You can automate this process via github action by using the command: |
| 46 | +```sh |
| 47 | +npm run build |
| 48 | +``` |
| 49 | +Check out an example [here.](https://github.com/abap2UI5/builder/blob/main/.github/workflows/build.yaml) |
| 50 | + |
| 51 | +### Supported Projects |
| 52 | +The following projects are supported: |
| 53 | + |
| 54 | +| Name | Renaming | Cloud | v750 | v702 | |
| 55 | +|-----------|----------|--------------|-------------|-------------| |
| 56 | +| [abap2UI5](https://github.com/abap2UI5/abap2UI5) | X | X | X | X | |
| 57 | +| [samples](https://github.com/abap2UI5/samples) | | X | X | X | |
| 58 | +| [layout-variant-management](https://github.com/abap2UI5-addons/layout-variant-management) | X | X | X | | |
| 59 | +| [table-maintenance](https://github.com/abap2UI5-addons/table-maintenance) | X | X | X | | |
| 60 | + |
| 61 | +Your project is not listed here? Feel free to send a PR and extend the list [here.](https://github.com/abap2UI5/builder/blob/main/setup/config-repos.jsonc) |
| 62 | + |
| 63 | +###### Legend |
| 64 | +* Cloud: S/4 Public Cloud, BTP ABAP Environment |
| 65 | +* v750: S/4 Private Cloud, S/4 On-Premise, R/3 NetWeaver 750 |
| 66 | +* v702: R/3 NetWeaver <750 |
21 | 67 |
|
22 |
| -### Blogs |
| 68 | +### Concept |
| 69 | +<img width="700" alt="image" src="https://github.com/user-attachments/assets/bad5ed8e-2fa3-4ce4-a0d1-fcd1608b4984" /> |
| 70 | + |
| 71 | + |
| 72 | +###### Namespace |
| 73 | +All artifacts are generated under the namespace `zabap2ui5`. This differs from the main repository to allow both versions to coexist on the same system. One version for modifications and contributions (z2ui5), this one for productive usage (zabap2ui5). Just change the `build.json` for the use of your custom namespace. |
| 74 | + |
| 75 | +###### Limitations & Todo |
| 76 | +* Renaming for Frontend with customer namespace eg. `/ZZZ/` [here](https://github.com/abap2UI5/abap2UI5/issues/1493) |
| 77 | + |
| 78 | +### Credits |
23 | 79 | * Automagic standalone renaming of ABAP objects [(SCN - 20.02.2021)](https://community.sap.com/t5/application-development-blog-posts/automagic-standalone-renaming-of-abap-objects/ba-p/13499851)
|
24 |
| -* Multiple installations of abap2xlsx in the same system [(SCN - 09.12.2023)](https://community.sap.com/t5/application-development-blog-posts/multiple-installations-of-abap2xlsx-in-the-same-system/ba-p/13578241) |
| 80 | +* Static Code Checks via [abaplint](https://abaplint.org/) [(contributors)](https://github.com/abaplint/abaplint/graphs/contributors) |
| 81 | + |
| 82 | +### Issues |
| 83 | +For bug reports or feature requests, please open an issue. |
0 commit comments