feat(gen-table): add script for inputs -> table #168
Conversation
This adds a lightweight script for taking in a reusable workflow yaml file and outputting a markdown table of the inputs. It's a nice utility for quickly creating or updating docs for reusable workflows.
There was a problem hiding this comment.
noice
how about adding something into CI to lint/format this, too?
- name: Lint Python
uses: advanced-security/python-lint-code-scanning-action@e5446e09fc7d49dd4a1290193d45a41ee72a0a40 # v1.1.1
with:
linter: flake8
Now, about the language... Although I don't actually personally mind too much, after this is merged we'd have code written in
- Go
- Typescript
- Python
in this repository. And I wonder if we should consolidate on two or if three is fine. I'll tag the recent contributors for their thoughts: @dsotirakis @zerok @ricky-undeadcoders
| if len(sys.argv) != 2: | ||
| print(__doc__) | ||
| sys.exit(1) | ||
| workflow_file = sys.argv[1] | ||
| main(Path(workflow_file)) |
There was a problem hiding this comment.
suggestion: might be a bit more robust to use argparse for this
| if len(sys.argv) != 2: | |
| print(__doc__) | |
| sys.exit(1) | |
| workflow_file = sys.argv[1] | |
| main(Path(workflow_file)) | |
| parser = argparse.ArgumentParser(description=__doc__, formatter_class=argparse.RawDescriptionHelpFormatter) | |
| parser.add_argument("workflow_file", type=Path, help="Path to the workflow YAML file") | |
| args = parser.parse_args() | |
| main(args.workflow_file) |
| print("Could not find the inputs in the workflow file. Please ensure the workflow is a reusable one and has inputs.") | ||
| sys.exit(1) | ||
|
|
||
| # adding 2 for the backticks |
There was a problem hiding this comment.
suggestion: Maybe consider splitting the function here-ish and having a def generate_table(inputs: Dict[str, any]) -> None
| with open(workflow_file, "r") as f: | ||
| workflow = yaml.safe_load(f) |
There was a problem hiding this comment.
there are some errors to be caught here, e.g. FileNotFoundError, yaml.yamlError
|
|
||
| ## Prerequisites | ||
|
|
||
| - Python 3.x |
There was a problem hiding this comment.
pyyaml seems to be an external dependency. Somehow I don't have it installed 😮
| print(f"| {'Name'.ljust(name_column_padding)} | {'Type'.ljust(type_column_padding)} | {'Description'.ljust(description_column_padding)} |") | ||
| print(f"| {'-' * name_column_padding} | {'-' * type_column_padding} | {'-' * description_column_padding} |") | ||
|
|
||
| for name, value in inputs.items(): |
There was a problem hiding this comment.
question - should we do this
| for name, value in inputs.items(): | |
| for name, value in sorted(inputs.items()): |
or is it better to keep them in the same order as in the action?
| workflow = yaml.safe_load(f) | ||
|
|
||
| try: | ||
| inputs = workflow[True]["workflow_call"]["inputs"] |
There was a problem hiding this comment.
main question: would it be hard to add support for our actions (not reusable workflows) in this tool too? it would be nice to have the same tables there - and we have more of those that we do reusable workflows!
|
|
||
|
|
||
| def main(workflow_file_path: Path): | ||
| with open(workflow_file, "r") as f: |
There was a problem hiding this comment.
| with open(workflow_file, "r") as f: | |
| with open(workflow_file_path, "r") as f: |
| import sys | ||
| import yaml | ||
| from pathlib import Path | ||
| from pprint import pprint |
There was a problem hiding this comment.
debug leftover
| from pprint import pprint |
I had the same thought about the language - I don't know if we want to add another language here, although looks pretty simple to do this in python. I wonder if a little bit more work (redoing this in Go) makes more sense too |
This adds a lightweight script for taking in a reusable workflow yaml file and outputting a markdown table of the inputs. It's a nice utility for quickly creating or updating docs for reusable workflows.