Skip to content
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

Jump to bottom

Add last commit badges #1565

Merged
merged 3 commits into from
Jun 26, 2022
Merged

Add last commit badges #1565

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a9d7dbe
Add last commit badges
bdovaz Jun 25, 2022
befb7e7
Add last commit badges
bdovaz Jun 25, 2022
b84dd75
Remove print
bdovaz Jun 25, 2022
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
40 changes: 34 additions & 6 deletions .automation/build.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -459,15 +459,17 @@ def generate_descriptor_documentation(descriptor):
descriptor_md += [
"## Linters",
"",
"| Linter | Configuration key |",
"| ------ | ----------------- |",
"| Linter | Configuration key | Status |",
"| ------ | ----------------- | ------ |",
]
for linter in descriptor.get("linters", []):
linter_name_lower = linter.get("linter_name").lower().replace("-", "_")
linter_doc_url = f"{lang_lower}_{linter_name_lower}.md"
badge = get_repository_badge_url(linter)
descriptor_md += [
f"| [{linter.get('linter_name')}]({doc_url(linter_doc_url)}) | "
f"[{linter.get('name', descriptor.get('descriptor_id'))}]({doc_url(linter_doc_url)}) |"
f" {badge} |"
]

# Criteria used by the descriptor to identify files to lint
Expand Down Expand Up @@ -611,8 +613,8 @@ def process_type(linters_by_type, type1, type_label, linters_tables_md):
linters_tables_md += [
f"### {type_label}",
"",
f"| <!-- --> | {col_header} | Linter | Configuration key | Format/Fix |",
"| :---: | ----------------- | -------------- | ------------ | :-----: |",
f"| <!-- --> | {col_header} | Linter | Configuration key | Format/Fix | Status |",
"| :---: | ----------------- | -------------- | ------------ | :-----: | :-----: |",
]
descriptor_linters = linters_by_type[type1]
prev_lang = ""
Expand Down Expand Up @@ -651,18 +653,21 @@ def process_type(linters_by_type, type1, type_label, linters_tables_md):
linter_doc_url = (
f"{DOCS_URL_DESCRIPTORS_ROOT}/{lang_lower}_{linter_name_lower}.md"
)
badge = get_repository_badge_url(linter)
linters_tables_md += [
f"| {icon_html} <!-- linter-icon --> | {descriptor_id_cell} | "
f"[{linter.linter_name}]({doc_url(linter_doc_url)})"
f"| [{linter.name}]({doc_url(linter_doc_url)})"
f"| {fix_col} |"
f"| {fix_col}"
f"| {badge} |"
]

# Build individual linter doc
linter_doc_md = [
"<!-- markdownlint-disable MD033 MD041 -->",
f"<!-- {'@'}generated by .automation/build.py, please do not update manually -->",
]
badge = get_repository_badge_url(linter)
# Header image as title
if (
hasattr(linter, "linter_banner_image_url")
Expand All @@ -677,6 +682,7 @@ def process_type(linters_by_type, type1, type_label, linters_tables_md):
"center",
150,
),
"\n" + badge
]
# Text + image as title
elif (
Expand All @@ -692,10 +698,11 @@ def process_type(linters_by_type, type1, type_label, linters_tables_md):
100,
)
+ linter.linter_name
+ " " + badge
]
# Text as title
else:
linter_doc_md += [f"# {linter.linter_name}"]
linter_doc_md += [f"# {linter.linter_name} {badge}"]

# Indicate that a linter is disabled in this version
if hasattr(linter, "disabled") and linter.disabled is True:
Expand Down Expand Up @@ -2201,6 +2208,27 @@ def generate_documentation_all_users():
file.write("\n".join(linter_doc_md) + "\n")
logging.info(f"Generated {REPO_HOME}/docs/all_users.md")

# https://shields.io/category/activity
def get_repository_badge_url(linter):
repo_url = None

if hasattr(linter, 'get') and linter.get("linter_repo") is not None and "github" in linter.get("linter_repo"):
repo_url = linter.get("linter_repo")
elif hasattr(linter, 'get') and linter.get("linter_url") is not None and "github" in linter.get("linter_url"):
repo_url = linter.get("linter_url")
elif hasattr(linter, 'linter_repo') and linter.linter_repo is not None and "github" in linter.linter_repo:
repo_url = linter.linter_repo
elif hasattr(linter, 'linter_url') and linter.linter_url is not None and "github" in linter.linter_url:
repo_url = linter.linter_url

badge = ""

if repo_url is not None:
match = re.search('https:\/\/github\.com\/(.*)\/(.*)', repo_url)

badge = f"[![GitHub last commit](https://img.shields.io/github/last-commit/{match.group(1)}/{match.group(2)})]({repo_url}/commits)"

return badge

# get github repo info using api
def get_github_repo_info(repo):
Expand Down