Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
book-open

GitHub Action

Update ShotGrid Readme

v1.0.1

Update ShotGrid Readme

book-open

Update ShotGrid Readme

Automatic README.md generator for ShotGrid frameworks/engines/apps and configurations

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: Update ShotGrid Readme

              
  uses: MaximumFX/tk-readme-generator@v1.0.1
Learn more about this action in MaximumFX/tk-readme-generator

Choose a version

Python 3.9 Code style: black

ShotGrid Readme Generator

CLI/GitHub Action README.md generator for ShotGrid frameworks/engines/apps.

GitHub Action

Add this GitHub Action to a workflow to automatically update the README.md when a change is committed to info.yml. See an example workflow here.

CLI

Requirements

Requires pyyaml

Usage

python tk-readme-generator.py <INFO_FILEPATH>

Options

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.