Skip to content

scripts: backstage: Warn on missing description #1553

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 2 commits into from
Feb 26, 2025
Merged

scripts: backstage: Warn on missing description #1553

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2970eec
scripts: backstage: Warn on missing description
gastmaier Jan 13, 2025
60a6b29
scripts: backstage: Info on warn on missing artifact
gastmaier Feb 13, 2025
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
22 changes: 17 additions & 5 deletions .github/scripts/gen_backstage_yaml.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
from typing import Dict, List, Tuple
from os import path, mkdir, walk, chdir
from glob import glob
import sys
import yaml
import re
import argparse
Expand Down Expand Up @@ -93,7 +94,8 @@ def get_description_parts(


def get_description(
data: List[str]
data: List[str],
file: str
) -> List[str]:
desc = []
directive_lock = False
Expand All @@ -109,6 +111,10 @@ def get_description(
else:
continue
desc.append(d)

if len(desc) < 3:
sys.exit(f"{file}: Missing overview/short-description.")

desc.pop()
desc.pop()
return desc
Expand Down Expand Up @@ -139,7 +145,7 @@ def get_description_library(

title = data[index-3][:-1]
data = data[index:]
desc = get_description(data)
desc = get_description(data, file)

return *get_description_parts(desc), title

Expand Down Expand Up @@ -182,7 +188,7 @@ def get_description_project(
index = index+1 if data[index] == '\n' else index

data = data[index:]
desc = get_description(data)
desc = get_description(data, file)

return *get_description_parts(desc), title

Expand Down Expand Up @@ -341,11 +347,12 @@ def concat_and_write_yaml(dir_: str) -> Tuple[List[str], str]:

files: Dict[str, List[str]] = {}

any_skipped = False;
for d in targets:
for d_ in targets[d]:
if d_ not in targets['main']:
print(f"Warning: {d} version of component {d_} not on "
"component (main), skipped")
any_skipped = True
print(f"Warning: {d}/{d_} not on component (main/*.yaml), skipped")
continue
if d_ in files:
files[d_].append('---\n')
Expand All @@ -361,6 +368,11 @@ def concat_and_write_yaml(dir_: str) -> Tuple[List[str], str]:
for line in files[d_]:
f.write(line)

if any_skipped:
print("If the skipped component was renamed on main, "
"please update the file name and the subcomponentOf field to match the new name. "
"The other fields should be kept the same to preserve history.")

return list(files.keys()), dir_


Expand Down