Skip to content

Return generated readme paths #515

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 18, 2025
Merged

Return generated readme paths #515

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions automation/script/doc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,10 @@ def generate_doc(self_module, input_params):
tag_values = input_params.get('tags', '').split(",")
variation_tags = [tag[1:] for tag in tag_values if tag.startswith("_")]

# Step 4: Iterate over scripts and generate Dockerfile
# capture path of generated README's for each script
generated_readme_paths = []

# Step 4: Iterate over scripts and generate readme
for script in sorted(scripts_list, key=lambda x: x.meta.get('alias', '')):
metadata = script.meta
script_directory = script.path
Expand All @@ -60,8 +63,10 @@ def generate_doc(self_module, input_params):
generic_inputs)
if r['return'] > 0:
continue
else:
generated_readme_paths.append(os.path.join(script_directory, "README.md"))

return {'return': 0}
return {'return': 0, 'generated_readme_paths': generated_readme_paths}


def get_setup_readme(script_repo):
Expand Down
Loading