GitHub Action
Update ShotGrid Readme
v1.1.1
Latest version
CLI/GitHub Action README.md generator for ShotGrid frameworks/engines/apps and configurations.
Add this GitHub Action to a workflow to automatically update the README.md when a change is committed to info.yml. See example workflows: framework/engine/app and configuration.
Requires pyyaml, semver
python tk-readme-generator.py <INFO_FILEPATH>
| Argument | Description |
|---|---|
| -o, --override | Override the existing readme. |
| -p FILEPATH, --prepend FILEPATH | Prepend an existing readme file after the name and description. |
| -a FILEPATH, --append FILEPATH | Append an existing readme file to the end. |
| -m MODE, --mode MODE | Make a readme for a general info file (framework/engine/app) or a config info file. (Options: general, config) |