CLI option to write built-in job compiler scripts to disk #99398

New Issue

Sybren A. Stüvel · 2022-07-04T14:45:28+02:00

Sybren A. Stüvel commented

2022-07-04 14:45:28 +02:00

Job compiler scripts are loaded from two sources:

intern/manager/job_compiler/scripts: embedded into the Flamenco Manager executable, and
scripts directory next to the exectuable, where the files are loaded from disk at startup.

The first location contains the built-in scripts bundled with Flamenco. The latter location is meant for users to create their own custom job types, or to override the built-in scripts.

It would be super useful if Flamenco Manager could write its embedded scripts to the scripts directory. There they would serve as a basis for customisation, or simply as example.

To avoid confusion, and to make upgrades smooth, it would be best if the written-to-disk copies of the embedded scripts were to use a different filename. This should be something that Flamenco Manager ignores, so that the scripts can purely serve their example purpose without getting in the way. A comment at the top of the file could explain how to name the file in order to override the built-in script, with a warning that this will prevent future updates (unless they remove/rename the script).

Job compiler scripts are loaded from two sources: - `intern/manager/job_compiler/scripts`: embedded into the Flamenco Manager executable, and - `scripts` directory next to the exectuable, where the files are loaded from disk at startup. The first location contains the built-in scripts bundled with Flamenco. The latter location is meant for users to create their own custom job types, or to override the built-in scripts. It would be super useful if Flamenco Manager could write its embedded scripts to the `scripts` directory. There they would serve as a basis for customisation, or simply as example. To avoid confusion, and to make upgrades smooth, it would be best if the written-to-disk copies of the embedded scripts were to use a different filename. This should be something that Flamenco Manager ignores, so that the scripts can purely serve their example purpose without getting in the way. A comment at the top of the file could explain how to name the file in order to override the built-in script, with a warning that this will prevent future updates (unless they remove/rename the script).

Sybren A. Stüvel commented

2022-07-04 14:45:28 +02:00

Changed status from 'Needs Triage' to: 'Confirmed'