hxltm-extras-action

[non-production-ready] Ad hoc GitHub Actions for non-HXL / non-HXLTM cli tools. See fititnt/hxltm-action#6

Table of Contents

Documentation
hxltm-extras-action tools
- POSIX commands
- csvkit
- csv-diff
- miller
- rows
- translate-toolkit
License

Documentation

This documentation explains the action.yml and entrypoint.sh.

Baseline inputs

Baseline inputs, together with Environment variables, are enough to abstract how to use the underlying command line tools.

`bin`

Required The executable to run.

Parameter examples:

csvstat

hxltmdexml (or .github/hxltm/hxltmdexml.py) (*)

`args`

Arguments passed for the program defined by bin parameter. Default: undefined.

Parameter examples:

--help

-v

--sheet 7 (Select sheet from a Excel workbook (1 is first sheet))

`infile`

The input file for the program defined by bin parameter ^{Note on non use of pipelines}. Default: undefined.

Parameter examples:

fontem.hxl.csv

fontem.tbx

`outfile`

The output file for the program defined by bin parameter ^{Note on non use of pipelines}. Default: undefined.

Parameter examples:

objectivum.tbx

objecricum.hxl.csv

Environment variables

See https://docs.github.com/en/actions/learn-github-actions/environment-variables.

Reusable defaults

The way GitHub Actions steps works, environment variables can be both passed at the entire job level or at specific tasks. One implication of action.yml and entrypoint.sh is that the use of environment variables at job level can be used to create default values for potentially repetitive values for each individual task.

TODO: test this potential implication and document it.

Syntactic sugar inputs

This section shows some syntactic sugar (or intentional syntactic saccharins) for what could be done using other ways, often with args parameter. Some of these only use English for what hxltm cli tools use Latin.

`syntactic-sugar-not-implemented`

None implemented on the current version. Use Baseline inputs and Environment variables.