Please let me know if this format makes sense and is readable. Also let me know if you think it contains all that is needed according to our docs.
Notes:
In the variables definition, the system will automaticaly replace a sequence of # characters in any string with random [A-Za-z\d] string to generate pseudo-unique identifiers.
When defining parameters for methods in any language, using $NAME would pull the value from a defined variable. One can also use a raw value, like my-project if it makes sense. This can be used to test various execution paths in samples, if there are any.
All paths are relative to the TOML file in this example. Perhaps it would be better to have them as relative to repository root, but I'm not sure.
The commands would be executed with subprocess.run(..., shell=True) in Python, making them work like if someone actually paste them into bash or sh - pipe'ing, input/output redirection etc. will work.
This file parses to something like this:
Please let me know if this format makes sense and is readable. Also let me know if you think it contains all that is needed according to our docs.
Notes:
variables
definition, the system will automaticaly replace a sequence of#
characters in any string with random[A-Za-z\d]
string to generate pseudo-unique identifiers.$NAME
would pull the value from a defined variable. One can also use a raw value, likemy-project
if it makes sense. This can be used to test various execution paths in samples, if there are any.subprocess.run(..., shell=True)
in Python, making them work like if someone actually paste them intobash
orsh
- pipe'ing, input/output redirection etc. will work.