An open API service indexing awesome lists of open source software.

https://github.com/fhem/fhem-controls-actions

Creates FHEM controls file via github actions
https://github.com/fhem/fhem-controls-actions

Last synced: 5 months ago
JSON representation

Creates FHEM controls file via github actions

Awesome Lists containing this project

README

          

# fhem-controls-actions JavaScript action (Version 2)

This action creates FHEM controls file via github actions which is compatible with `update all ` and `update add ` command.
More details about this command at the [Fhem Wiki](https://wiki.fhem.de/wiki/Update#update_all).

## Inputs

### `filename`

**Required** The name of controls file. Should be named `controls_.txt`

### `directory`

**Optional** The name of the directory where the files are located which should be updated `FHEM`

### `extension`

**Optional** The file extension which should be included in the controls file. Normaly `.pm` for Perl Modules.
You can specify multiple extions by separing them with '|'. To get all '.pm' and all '.json' files you can write '.pm|.json'.

**Note**: The extemsion string itself will be interpreded as a regex which acts as a filter on the files. The filename must end with one of the given extions. Dots are always escaped and interpreded as a dot and not as a wildcard for any char.

### `writemode`

**Optional** You can controle the writemode which is used to open the file. Default w, which will create or truncate the controls file.
If you want to append data, to an existing controls file, then you can specify the value a for writemode.

## Outputs
### `controls_content`
Same content which is also written into the controls file

## Example usage
1. Checkout the repository

```
steps:
- name: Checkout Repostory
uses: actions/checkout@v3
with:
fetch-depth: 0

```

2. You can create the controls file
```
- name: update controls files
uses: fhem/fhem-controls-actions@v2.1.0
with:
filename: controls_rsl.txt
```
...
Push back the changes via https://github.com/marketplace/actions/github-push