Added AddOns documentation

powerIO-GmbH · Mar 20, 2024 · e0975c8 · e0975c8
1 parent a4d8821
commit e0975c8
Show file tree

Hide file tree

Showing 2 changed files with 77 additions and 22 deletions.
diff --git a/.github/workflows/setup.yml b/.github/workflows/setup.yml
@@ -28,6 +28,7 @@ jobs:
       uses: ./
       with:
         installer-version: 2.2.2
+        auto-update-installer: false
         generation: ${{ matrix.generation }}
         architecture: ${{ matrix.architecture }}
         patch: ${{ matrix.patch }}

diff --git a/README.md b/README.md
@@ -15,28 +15,50 @@ It can also be used to process test cases or other CI/CD jobs in your workflow.
 >:white_flag: See the [inputs](#inputs) section for detailed descriptions.
 
 ```yml
-- name: Setup CODESYS
-  uses: powerIO-GmbH/action-codesys-setup@v<version>
-  with:
-    installer-version: 2.2.2
-    auto-update-installer: false
-    generation: 3.5.19.0
-    architecture: 64
-    patch: 6
-    hotfix: 0
-    build: 0 
+  - name: Setup CODESYS
+    uses: powerIO-GmbH/action-codesys-setup@v<version>
+    with:
+      installer-version: 2.2.2
+      auto-update-installer: false
+      generation: 3.5.19.0
+      architecture: 64
+      patch: 6
+      hotfix: 0
+      build: 0 
 ```
 
 ## Usage examples
 
 - Install CODESYS Version `3.5.17.2`:
 ```yml
-- name: Setup CODESYS
-  uses: powerIO-GmbH/action-codesys-setup@v<version>
-  with:
-    generation: 3.5.17.0
-    architecture: 64
-    patch: 2
+  - name: Setup CODESYS
+    uses: powerIO-GmbH/action-codesys-setup@v<version>
+    with:
+      generation: 3.5.17.0
+      architecture: 64
+      patch: 2
+```
+
+- Install CODESYS Version `3.5.20.0` with following packages.
+  * _CODESYS Git_ Version 1.4.0.0
+  * _CODESYS Library Documentation Support_ Version 4.5.0.0
+  * Custom package file, in this case _HVAC Building & Automation_ 
+
+```yml
+    - name: Setup CODESYS
+      id: setup_codesys
+      uses: powerIO-GmbH/action-codesys-setup@v<version>
+      with:
+        installer-version: 2.2.2
+        auto-update-installer: true
+        generation: 3.5.20.0
+        architecture: 64
+        install-add-ons: true
+        add-ons-list: |
+          dd6c2da4-2ed2-4076-9bf7-52394db68819,1.4.0.0
+          fb6f3506-d165-4e75-a1b9-98895d542cc8,4.5.0.0
+        add-ons-from-file-list: |
+          example/HVAC_Building_Process_Automation_SL_3.0.0.0.package
 ```
 
 ## Inputs
@@ -108,11 +130,43 @@ The action supports the following inputs:
   **required:** *false*  
   **default:** *`true`* 
 
+- `install-add-ons`
+
+  If set to `true`, the installer will install the CODESYS AddOns.
+
+  **required:** *false*  
+  **default:** *`false`* 
+
+- `add-ons-list`
+
+  A list of addons to install.
+  Given by the id and the version of the addon.
+  For example - Install Git: `dd6c2da4-2ed2-4076-9bf7-52394db68819,1.4.0.0`  
+
+  If you want to install multiple addons, create a new line for each addon.  
+  For example - Install Git and Library dev package:  
+  ```
+  dd6c2da4-2ed2-4076-9bf7-52394db68819,1.4.0.0
+  fb6f3506-d165-4e75-a1b9-98895d542cc8,4.5.0.0
+  ``` 
+
+  **required:** *false*  
+  **default:** *`''`* 
+
+- `add-ons-from-file-list`
+
+  A list of addons to install.
+  Given by the path to the `<name>.package` file
+
+  **required:** *false*  
+  **default:** *`''`* 
+
 ## Outputs
 
-| Output                     | Description                                       |
-| -------------------------- | ------------------------------------------------- |
-| `codesys-path`             | The path of the installed CODESYS version.        |
-| `codesys-executable`       | The path of the CODESYS executable.               |
-| `installer-path`           | The path of the installed CODESYS installer.      |
-| `installer-cli-executable` | The path of the CODESYS installer CLI executable. |
+| Output                        | Description                                       |
+| ----------------------------- | ------------------------------------------------- |
+| `codesys-path`                | The path of the installed CODESYS version.        |
+| `codesys-executable`          | The path of the CODESYS executable.               |
+| `installer-path`              | The path of the installed CODESYS installer.      |
+| `installer-cli-executable`    | The path of the CODESYS installer CLI executable. |
+| `installation-info-file-path` | The path of the installation information file.    |