mtan93/Installomator
1
0
Fork 0
mirror of https://github.com/mtan93/Installomator.git synced 2026-03-08 05:31:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Armin Briegel
2022-05-18 17:27:34 +02:00
committed by GitHub
parent dd98c13e40
commit a22e656146
1 changed files with 7 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
utils/README.md
View File

@@ -1,6 +1,6 @@
# How to assemble Installomator.sh # How to assemble Installomator.sh
Since the Installomator.sh script has grown to over 3000 lines, its management on git has become very unwieldy. The single file with all the logic and the data required to download and install the applications creates constant merge conflicts which add to the workload of the repo admins, especially when part of the team is working on the logic of the script while we still get PRs to add labels. Since the Installomator.sh script has grown to over 5000 lines, its management on git has become very unwieldy. The single file with all the logic and the data required to download and install the applications creates constant merge conflicts which add to the workload of the repo admins, especially when part of the team is working on the logic of the script while we still get PRs to add labels.
Because of that we have split the main script into multiple files which are easier to manage. Having multiple files results in less merge conflicts. Because of that we have split the main script into multiple files which are easier to manage. Having multiple files results in less merge conflicts.
@@ -53,7 +53,7 @@ Once you are certain that your new custom label works, you can use the code from
The `Installomator.sh` script at the root of the repo does not really get involved in your building and testing. Similarly, if you want to apply, test, and contribute changes to the script's logic, you should modify the fragment file in question and test using the assemble script. The `Installomator.sh` script at the root of the repo does not really get involved in your building and testing. Similarly, if you want to apply, test, and contribute changes to the script's logic, you should modify the fragment file in question and test using the assemble script.
Pull requests against the `Installomator.sh` script in the root of the repo will be rejected. (Excepting the backlog of existing PRs.) Pull requests against the `Installomator.sh` script in the root of the repo will be rejected.
## How do I contribute new or modified labels back to the Installomator project? ## How do I contribute new or modified labels back to the Installomator project?
@@ -70,11 +70,13 @@ If you have multiple labels (or other changes) you want to contribute, please cr
Once your Pull Request is merged into the main repo, you can pull the change to your local repo, push it to your fork, and delete the branch, because it should be fully merged. Once your Pull Request is merged into the main repo, you can pull the change to your local repo, push it to your fork, and delete the branch, because it should be fully merged.
When you have multiple labels or changes, please create a separate issue for each label or change, unless they are closely related
### When you are not familiar with git and GitHub ### When you are not familiar with git and GitHub
Create an Issue in the Installomator repo and include the contents of your custom label file. We have a tutorial on [How to create Pull Requests in GitHub](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue).
If you have multiple labels, please create a separate issue for each label.
## Fragments ## Fragments
@@ -109,7 +111,7 @@ All the contents of the label files in `labels` (and any custom label locations
Finally, the `main.sh` fragment contains most of the main logic. Finally, the `main.sh` fragment contains most of the main logic.
The assemble script does not check _any_ of the files for syntax or completeness. You are responsible that everything fits together properly. (Pay special attention to remember the closing semi-colons `;;` in the label files.) The assemble script does not check _any_ of the files for syntax or completeness. You are responsible that everything fits together properly. (Pay special attention to remember the closing semi-colons `;;` and a final line break in the label files.)
## assemble.sh Usage ## assemble.sh Usage