Repository: {{ name }} URL: {{ url }}
{%- if let (Some(report), Some(score)) = (report.as_ref(), score.as_ref()) %}
Checks sets: {% for check_set in check_sets %}{{ check_set }}{% if !loop.last %} + {% endif %}{% endfor %}
Score: {{ score.global.round() }}
| Category | Score |
|---|---|
| Documentation | {% call category_score(score.documentation) %} |
| License | {% call category_score(score.license) %} |
| Best Practices | {% call category_score(score.best_practices) %} |
| Security | {% call category_score(score.security) %} |
| Legal | {% call category_score(score.legal) %} |
{% if let Some(value) = score.documentation -%}
{% call check("adopters", "Adopters", report.documentation.adopters) -%} {% call check("changelog", "Changelog", report.documentation.changelog) -%} {% call check("code-of-conduct", "Code of conduct", report.documentation.code_of_conduct) -%} {% call check("contributing", "Contributing", report.documentation.contributing) -%} {% call check("governance", "Governance", report.documentation.governance) -%} {% call check("maintainers", "Maintainers", report.documentation.maintainers) -%} {% call check("readme", "Readme", report.documentation.readme) -%} {% call check("roadmap", "Roadmap", report.documentation.roadmap) -%} {% call check("summary-table", "Summary Table", report.documentation.summary_table) -%} {% call check("website", "Website", report.documentation.website) -%}
{%- endif %} {%- if let Some(value) = score.license %}
{% call license_spdx_id_check(report.license.license_spdx_id) -%} {% call check("approved-license", "Approved license", report.license.license_approved) -%} {% call check("license-scanning", "License scanning", report.license.license_scanning) -%}
{%- endif %} {%- if let Some(value) = score.best_practices %}
{% call check("artifact-hub-badge", "Artifact Hub badge", report.best_practices.artifacthub_badge) -%} {% call check("contributor-license-agreement", "Contributor License Agreement", report.best_practices.cla) -%} {% call check("community-meeting", "Community meeting", report.best_practices.community_meeting) -%} {% call check("developer-certificate-of-origin", "Developer Certificate of Origin", report.best_practices.dco) -%} {% call check("github-discussions", "Github discussions", report.best_practices.github_discussions) -%} {% call check("openssf-badge", "OpenSSF best practices badge", report.best_practices.openssf_badge) -%} {% call check("openssf-scorecard-badge", "OpenSSF Scorecard badge", report.best_practices.openssf_scorecard_badge) -%} {% call check("recent-release", "Recent release", report.best_practices.recent_release) -%} {% call check("slack-presence", "Slack precense", report.best_practices.slack_presence) -%}
{%- endif %} {%- if let Some(value) = score.security %}
{% call check("binary-artifacts-from-openssf-scorecard", "Binary artifacts", report.security.binary_artifacts) -%} {% call check("code-review-from-openssf-scorecard", "Code review", report.security.code_review) -%} {% call check("dangerous-workflow-from-openssf-scorecard", "Dangerous workflow", report.security.dangerous_workflow) -%} {% call check("dependencies-policy", "Dependencies policy", report.security.dependencies_policy) -%} {% call check("dependency-update-tool-from-openssf-scorecard", "Dependency update tool", report.security.dependency_update_tool) -%} {% call check("maintained-from-openssf-scorecard", "Maintained", report.security.maintained) -%} {% call check("software-bill-of-materials-sbom", "Software bill of materials (SBOM)", report.security.sbom) -%} {% call check("security-insights", "Security insights", report.security.security_insights) -%} {% call check("security-policy", "Security policy", report.security.security_policy) -%} {% call check("signed-releases-from-openssf-scorecard", "Signed releases", report.security.signed_releases) -%} {% call check("token-permissions-from-openssf-scorecard", "Token permissions", report.security.token_permissions) -%}
{%- endif %} {%- if let Some(value) = score.legal %}
{% call check("trademark-disclaimer", "Trademark disclaimer", report.legal.trademark_disclaimer) -%}
{%- endif %} For more information about the checks sets available and how each of the checks work, please see the CLOMonitor's documentation.
{%- else %}
This repository hasn't been processed yet, please try again later. {%- endif -%}
{% macro check(doc_id, display_name, option) %}
{%- if let Some(check_output) = option -%}
- [{% if check_output.passed || check_output.exempt %}x{% else %} {% endif %}]
{%- if let Some(link) = check_output.url %} [{{ display_name }}]({{ link }}) {% else %} {{ display_name }} {% endif -%}
([docs](https://clomonitor.io/docs/topics/checks/#{{ doc_id }}))
{%- if check_output.exempt %} EXEMPT{%- endif %}
{%- if check_output.failed %} CHECK FAILED{%- endif %}
{% endif -%}
{%- endmacro %}
{% macro license_spdx_id_check(option) %}
{%- if let Some(check_output) = option -%}
- [{% if check_output.passed || check_output.exempt %}x{% else %} {% endif %}] {{ check_output.value.as_deref().unwrap_or("Not detected") }} (docs)
{%- if check_output.exempt %} EXEMPT{%- endif %}
{%- if check_output.failed %} CHECK FAILED{%- endif %}
{% endif -%}
{%- endmacro %}
{% macro category_score(option) %} {%- if let Some(value) = option -%}{{ value.round() }}%{%- else -%}n/a{%- endif -%} {% endmacro %}