https://github.com/powerio-gmbh/action-codesys-setup
This action is designed to install CODESYS for further CI/CD jobs, such as signing libraries, signing packages, etc. It can also be used to process test cases or other CI/CD jobs in your workflow.
https://github.com/powerio-gmbh/action-codesys-setup
action codesys continous-deployment continuous-integration
Last synced: 5 months ago
JSON representation
This action is designed to install CODESYS for further CI/CD jobs, such as signing libraries, signing packages, etc. It can also be used to process test cases or other CI/CD jobs in your workflow.
- Host: GitHub
- URL: https://github.com/powerio-gmbh/action-codesys-setup
- Owner: powerIO-GmbH
- License: mit
- Created: 2024-03-19T18:59:23.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-02-17T12:43:29.000Z (over 1 year ago)
- Last Synced: 2025-04-11T22:12:16.153Z (about 1 year ago)
- Topics: action, codesys, continous-deployment, continuous-integration
- Homepage:
- Size: 20.5 MB
- Stars: 6
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Github action setup CODESYS
> This github action is used to install CODESYS for CI/CD jobs.
[](https://github.com/powerIO-GmbH/action-codesys-setup/actions/workflows/setup.yml)
## About
This action is designed to install CODESYS for further CI/CD jobs, such as signing libraries, signing packages, etc.
It can also be used to process test cases or other CI/CD jobs in your workflow.
> [!IMPORTANT]
> This action is only supported to run on windows OS.
> [!WARNING]
> From CODESYS Installer Version >= `2.5.0.0` CODESYS changed the Version format to `...`.
> Versions < `2.5.0.0` used the Version format `..`.
> To use a specific version, check the CODESYS Installer versions from the [version history](https://store.codesys.com/en/codesys-installer.html#product.attributes.wrapper).
## Usage
>:white_flag: See the [inputs](#inputs) section for detailed descriptions.
```yml
- name: Setup CODESYS
uses: powerIO-GmbH/action-codesys-setup@v1
with:
installer-version: 2.6.0.0
auto-update-installer: false
generation: 3.5.21.0
architecture: 64
patch: 4
```
## Usage examples
- Install the CODESYS Installer without a CODESYS installation.
```yml
- name: Setup CODESYS Installer Only
uses: powerIO-GmbH/action-codesys-setup@v1
with:
installer-only: true
installer-version: 2.6.0.0
auto-update-installer: true
```
- Install CODESYS Version `3.5.20.4`:
```yml
- name: Setup CODESYS
uses: powerIO-GmbH/action-codesys-setup@v1
with:
generation: 3.5.20.0
architecture: 64
patch: 4
```
- 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 _NetBaseServices Example_
* Exported Add-Ons list from the CODEYS Installer, of a existing installation `.installation-config` File.
```yml
- name: Setup CODESYS
id: setup_codesys
uses: powerIO-GmbH/action-codesys-setup@v1
with:
installer-version: 2.6.0.0
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/custom_packages/NetBaseServices_Example_1.0.0.0.package
add-ons-installer-import-file: |
example/custom_import_files/example_import_add-ons.installation-config
```
## Inputs
| Input | Description | Required | Default |
|-------|-------------|----------|----------|
| `installer-only` | If set to `true`, only the installer will be installed without a CODESYS installation. | false | `false` |
| `installer-version` | The version of the installer to use to install the CODESYS installation. | false | `2.6.0.0` |
| `generation` | This is the base generation you want to install (e.g., `3.5.21.0`). Even if you want to install version `3.5.21.2`, you have to define the generation as `3.5.21.0`. The patch version is defined by the `patch` input. | false | `3.5.21.0` |
| `architecture` | The installation architecture of CODESYS. Allowed inputs: `32` and `64`. | false | `64` |
| `patch` | The patch of the CODESYS version to install. | false | `0` |
| `hotfix` | The hotfix of the CODESYS version to install. | false | `0` |
| `build` | The build of the CODESYS version to install. | false | `0` |
| `installation-directory` | Custom installation directory. If empty, the path is set based on architecture and installation version. Examples:
- 64-bit, generation 3.5.19.0, patch 6: `C:\Program Files\CODESYS 3.5.19.6`
- 32-bit, generation 3.5.17.0, patch 2: `C:\Program Files (x86)\CODESYS 3.5.17.2` | false | `''` |
| `auto-update-installer` | If set to `true`, the installer will be updated before the installation. | false | `true` |
| `install-add-ons` | If set to `true`, the installer will install the CODESYS AddOns. | false | `false` |
| `add-ons-list` | List of addons to install, given by ID and version. Example:
`dd6c2da4-2ed2-4076-9bf7-52394db68819,1.4.0.0`
For multiple addons, create a new line for each addon. | false | `''` |
| `add-ons-from-file-list` | List of addons to install, given by the path to the `.package` file. | false | `''` |
| `add-ons-installer-import-file` | Path to the exported installer add-ons file. This file can be created by exporting the installed add-ons from an existing installation. The file usually has the extension `.installation-config` | false | `''` |
## Outputs
| Output | Description |
| ----------------------------- | ------------------------------------------------- |
| `codesys-path` | The path of the installed CODESYS version. (Not available when `installer-only` is true) |
| `codesys-executable` | The path of the CODESYS executable. (Not available when `installer-only` is true) |
| `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. (Not available when `installer-only` is true) |
| `add-ons-info-file-path` | The path of the add-ons information file. (Not available when `installer-only` is true) |