giantswarm / crd-docs-generator
Tooling to create user-friendly reference documentation for Kubernetes Custom Resource Definitions (CRDs)
giantswarm/crd-docs-generator erreicht einen Gesundheitsindex von 87 von 100 und liegt damit im Bereich Exzellent. Am stärksten schneidet es bei Vitality (91/100) ab, am schwächsten bei Community & Adoption (44/100). Zuletzt vor 1 Tag aktualisiert. Ein einzelner Mitwirkender trägt den Großteil der jüngsten Arbeit.
Software-Gesundheitsindex
Metriken werden auf einer standardisierten Skala von 1–100 in gewichtete Kategorien gruppiert. Der Gesamtwert beginnt als ihr gewichtetes Mittel, kalibriert auf die Verteilung des öffentlichen Registers, sodass die Stufen Perzentilbedeutung tragen; sobald öffentliche Evidenz die Richtlinie für Hochrisikojurisdiktionen auslöst, wird die Bewertung angepasst und erhält die Obergrenze Gefährdet von 34.
Bewertungsprofil
Jede Achse ist eine Kategorie. Die Form zählt mehr als der Durchschnitt — ein gesundes Projekt füllt die gesamte Fläche, während ein Profil aus Spitzen und Kratern bedeutet, dass Stärke in einer Dimension Risiken in einer anderen verdeckt.
Der gewichtete Gesamtwert 73 wird auf der veröffentlichten Indexskala auf 87 kalibriert (Register-Kalibrierung 2026-08-02).
Eigentümerschaft
Dieses Repository wird von einer Organisation getragen — geteilte, rechenschaftspflichtige Trägerschaft, die jeden einzelnen Maintainer überdauern kann.
Paket-Ökosysteme
| Registry | Paket | Version | Downloads / Monat | Versionen | Zuletzt veröffentlicht |
|---|---|---|---|---|---|
| Go | github.com/giantswarm/crd-docs-generator | v0.12.13 | - | 37 | vor 17 Tagen |
Metriken nach Kategorie
Vitalität
Lebt das Projekt — wird Code geschrieben und werden Releases ausgeliefert?
Entwicklungsaktivität
Wie die Bewertung erfolgt
| 36/36 | Push-Aktualität — letzter Push vor 1 Tagen |
| 28.4/36 | Commit-Rhythmus — 41/52 Wochen mit Commits |
| 18/18 | Commit-Volumen — 100 Commits im letzten Jahr |
| 10/10 | OpenSSF Scorecard: Maintained — 30 commit(s) and 1 issue activity found in the last 90 days -- score normalized to 10 |
Verwendete Eingangsdaten
| commits_last_year | 100 |
| human_commit_share | 0,22 |
| days_since_last_push | 1 |
| active_weeks_last_year | 41 |
Release-Disziplin
Wie die Bewertung erfolgt
| 27/27 | Liefert Releases aus — 37 Releases veröffentlicht |
| 36/36 | Release-Aktualität — letztes Release vor 17 Tagen |
| 27/27 | Release-Rhythmus — ein Release etwa alle 3,8 Tage |
| 0/10 | OpenSSF Scorecard: Signed-Releases — Project has not signed or included provenance with any releases. |
Verwendete Eingangsdaten
| releases_count | 37 |
| latest_release_tag | v0.12.13 |
| releases_from_tags | nein |
| days_since_latest_release | 17 |
| mean_days_between_releases | 3,8 |
Community & Verbreitung
Hat das Projekt Nutzer, Downloads, Aufmerksamkeit und ein einladendes Umfeld für Beitragende?
Popularität & Verbreitung
Wie die Bewertung erfolgt
| 23/60 | Stars — 27 Stars |
| 5/25 | Forks — 5 Forks |
| 5/15 | Watcher — 9 Watcher |
Verwendete Eingangsdaten
| forks | 5 |
| stars | 27 |
| watchers | 9 |
| growth_state | unverified |
| growth_factor_pct | 100 |
| growth_unverified_reason | no_history |
Community-Gesundheit
Wie die Bewertung erfolgt
| 22.5/22.5 | README |
| 22.5/22.5 | Lizenz — anerkannte Lizenz (Apache-2.0) |
| 0/18 | CONTRIBUTING-Leitfaden |
| 0/13.5 | Verhaltenskodex |
| 0/7.2 | Issue-Vorlage |
| 6.3/6.3 | PR-Vorlage |
Verwendete Eingangsdaten
| has_readme | ja |
| has_license | ja |
| readme_badges | 1 |
| has_contributing | nein |
| has_issue_template | nein |
| has_code_of_conduct | nein |
| readme_badge_services | circleci.com |
| has_pull_request_template | ja |
Nachhaltigkeit & Governance
Überdauert das Projekt die Menschen, die es tragen — Bus-Faktor, Reaktionsfähigkeit, Trägerschaft und Paketpflege?
Maintainer-Resilienz (Bus-Faktor)
Wie die Bewertung erfolgt
| 9/54 | Bus-Faktor — 1 Beitragende decken die Hälfte aller Commits ab |
| 8.5/22.5 | Commit-Verteilung — wichtigste beitragende Person verfasste 62 % der Commits |
| 13.5/13.5 | Breite der Beitragenden — 11 Beitragende |
| 10/10 | OpenSSF Scorecard: Contributors — project has 4 contributing companies or organizations |
Verwendete Eingangsdaten
| bus_factor | 1 |
| contributors_sampled | 11 |
| top_contributor_share | 0,624 |
Reaktionsfähigkeit bei Issues & PRs
Wie die Bewertung erfolgt
| 36.8/42 | Issue-Lösungsquote — 88 % der Issues geschlossen |
| 28.6/30 | PR-Annahme — 407/427 entschiedene PRs gemergt |
| 0/13 | Newcomer PR acceptance — kein PR eines Erstbeitragenden in 30 Tagen entschieden |
| 4.5/15 | OpenSSF Scorecard: Code-Review — Found 1/3 approved changesets -- score normalized to 3 |
Verwendete Eingangsdaten
| merged_prs | 407 |
| open_issues | 1 |
| closed_issues | 7 |
| prs_merged_7d | 0 |
| prs_decided_7d | 0 |
| prs_merged_30d | 0 |
| prs_decided_30d | 0 |
| issue_closed_ratio | 0,875 |
| closed_unmerged_prs | 20 |
| first_time_authors_30d | 0 |
| first_time_prs_merged_30d | 0 |
| first_time_prs_decided_30d | 0 |
Eigentümerschaft & Trägerschaft
Wie die Bewertung erfolgt
| 30/30 | Organisatorische Trägerschaft — im Besitz einer Organisation |
| 0/20 | Verifizierte Domain — Verifizierungsstatus der Domain für diese Organisation nicht ausgelesen |
| 15.5/25 | Reichweite des Inhabers — 144 Follower von giantswarm |
| 25/25 | Kontohistorie — 1.164 öffentliche Repos, Kontoalter ca. 12 Jahre |
Verwendete Eingangsdaten
| followers | 144 |
| owner_type | Organization |
| is_verified | — |
| owner_login | giantswarm |
| public_repos | 1.164 |
| account_age_days | 4.477 |
Paketpflege
Wie die Bewertung erfolgt
| 25/25 | Veröffentlicht & auflösbar — 1 Paket(e) auf go |
| 35/35 | Veröffentlichungsaktualität — letzte Veröffentlichung vor 17 Tagen |
| 20/20 | Versionshistorie — 37 veröffentlichte Versionen |
| 20/20 | Nicht veraltet — aktiv, nicht veraltet oder zurückgezogen |
Verwendete Eingangsdaten
| packages | github.com/giantswarm/crd-docs-generator |
| ecosystems | go |
| any_deprecated | nein |
| min_days_since_publish | 17 |
Engineering-Qualität
Sind grundlegende Engineering- und Dokumentationspraktiken vorhanden?
Engineering-Praktiken
Wie die Bewertung erfolgt
| 24/24 | CI-Workflows — 8 Workflow(s) |
| 24/24 | Tests vorhanden |
| 16/16 | Linter-Konfiguration |
| 9.6/9.6 | Pre-Commit-Hooks |
| 0/6.4 | .editorconfig |
| 20/20 | OpenSSF Scorecard: CI-Tests — 30 out of 30 merged PRs checked by a CI test -- score normalized to 10 |
Verwendete Eingangsdaten
| has_ci | ja |
| has_tests | ja |
| has_editorconfig | nein |
| has_linter_config | ja |
| has_precommit_config | ja |
Dokumentation
Wie die Bewertung erfolgt
| 30/30 | README |
| 0/25 | Dokumentationsverzeichnis |
| 0/15 | Dokumentations-/Homepage-Site |
| 10/10 | Repository-Beschreibung |
| 10/10 | Topics — 3 Topics |
| 0/10 | Wiki |
Verwendete Eingangsdaten
| topics | documentation, documentation-generator, kubernetes |
| has_wiki | nein |
| homepage | — |
| docs_site | — |
| has_readme | ja |
| has_docs_dir | nein |
| has_description | ja |
Sicherheit
Sind die sichtbaren Sicherheits- und Lieferkettenpraktiken belastbar, ohne ungeklärte Exposition gegenüber Hochrisikojurisdiktionen?
Sicherheitslage
Wie die Bewertung erfolgt
| 7.5/7.5 | Binary-Artifacts — no binaries found in the repo |
| 0/7.5 | Branch-Protection — keine Daten |
| 2.5/2.5 | CI-Tests — 30 out of 30 merged PRs checked by a CI test -- score normalized to 10 |
| 0/2.5 | CII-Best-Practices — no effort to earn an OpenSSF best practices badge detected |
| 2.2/7.5 | Code-Review — Found 1/3 approved changesets -- score normalized to 3 |
| 2.5/2.5 | Contributors — project has 4 contributing companies or organizations |
| 10/10 | Dangerous-Workflow — no dangerous workflow patterns detected |
| 7.5/7.5 | Dependency-Update-Tool — update tool detected |
| 0/5 | Fuzzing — project is not fuzzed |
| 2.5/2.5 | Lizenz — license file detected |
| 7.5/7.5 | Maintained — 30 commit(s) and 1 issue activity found in the last 90 days -- score normalized to 10 |
| 0/5 | Packaging — keine Daten |
| 3/5 | Pinned-Dependencies — dependency not pinned by hash detected -- score normalized to 6 |
| 0/5 | SAST — SAST tool is not run on all commits -- score normalized to 0 |
| 5/5 | Security-Policy — security policy file detected |
| 0/7.5 | Signed-Releases — Project has not signed or included provenance with any releases. |
| 0/7.5 | Token-Permissions — detected GitHub workflow tokens with excessive permissions |
| 6/7.5 | Vulnerabilities — 2 existing vulnerabilities detected |
Verwendete Eingangsdaten
| source | openssf_scorecard |
| checks_evaluated | 16 |
| scorecard_version | v5.5.0 |
| checks_inconclusive | 2 |
| scorecard_aggregate | 6,1 |
Abhängigkeits-Advisories
Wie die Bewertung erfolgt
| 35/35 | Direkte Abhängigkeiten ohne bekannte Advisories — keine direkte Abhängigkeit trägt ein bekanntes Advisory |
| 0/25 | Indirekte Abhängigkeiten ohne bekannte Advisories — transitive Menge in diesem Bereich nicht von Entwicklungs- und Test-Abhängigkeiten trennbar |
| 0/40 | Keine offenen Advisories — kein Advisory trägt ein Veröffentlichungsdatum |
Verwendete Eingangsdaten
| source | osv |
| advisories | 2 |
| affected_packages | 2 |
| assessed_packages | 38 |
| unassessed_packages | 0 |
| affected_by_severity | unknown 2 |
| direct_affected_packages | 0 |
AI Readiness
Wie gut ist das Repository dafür ausgestattet, mit KI-Coding-Agenten entwickelt und gepflegt zu werden? Trägt ein bewusst kleines Gewicht (4 %): Agenten-Tooling ist ein echtes Pflegesignal, doch ein Repository ohne jedes Signal kann weiterhin 100/100 erreichen.
AI-Agentenkontext & Leitlinien
Wie die Bewertung erfolgt
| 45/45 | Agentenanweisungen — .cursor/rules/configuration.mdc, .cursor/rules/zz_generated.base-llm-rules.mdc, .cursor/rules/zz_generated.go-llm-rules.mdc |
| 0/15 | Maschinenlesbare Doku (llms.txt) |
| 40/40 | Lesbare Commit-Historie — 22 von 22 menschlichen Commits benennen ihre Absicht (strukturierter Betreff oder erläuternder Text) |
Verwendete Eingangsdaten
| has_llms_txt | nein |
| llms_txt_url | — |
| legible_history_share | 1 |
| agent_instruction_files | .cursor/rules/configuration.mdc, .cursor/rules/zz_generated.base-llm-rules.mdc, .cursor/rules/zz_generated.go-llm-rules.mdc |
| agent_instruction_max_bytes | 3.012 |
AI-Verify-Loop (Build / Test / Typprüfung)
Wie die Bewertung erfolgt
| 18/18 | Bootstrap mit einem Befehl — Makefile |
| 22/22 | Automatisierte Tests |
| 11/11 | Lint-/Format-Konfiguration |
| 11/11 | Statische Typprüfung — Go (statisch typisiert) |
| 10/10 | Reproduzierbare Umgebung — Dockerfile, lockfile |
| 4/10 | Belegte Agentenpraxis — 2 der letzten 100 Commits von Agenten verfasst oder ihnen zugeschrieben |
| 8/8 | Automatisierte Wartung — 65 der letzten 100 Commits sind automatisierte Abhängigkeits-Updates |
| 6/10 | OpenSSF Scorecard: Pinned-Dependencies — dependency not pinned by hash detected -- score normalized to 6 |
Verwendete Eingangsdaten
| has_nix | nein |
| has_tests | ja |
| lockfiles | go.sum |
| has_dockerfile | ja |
| typed_language | ja |
| bootstrap_files | Makefile |
| has_devcontainer | nein |
| has_linter_config | ja |
| typecheck_configs | — |
| agent_commit_share | 0,02 |
| toolchain_manifests | go.mod |
| dependency_bot_commit_share | 0,65 |
AI-Code-Lesbarkeit für Modelle
Wie die Bewertung erfolgt
| 45/45 | Typprüfbarer Code — Go (statisch typisiert) |
| 55/55 | Handhabbare Dateigrößen — 0/18 Quelldateien über 60 KB |
Verwendete Eingangsdaten
| primary_language | Go |
| largest_source_bytes | 8.141 |
| source_files_sampled | 18 |
| oversized_source_files | 0 |
Eckdaten
Warnungen zur Datenerhebung
- Star history unavailable: GitHub GraphQL error: Resource not accessible by personal access token
Weitere Details
Stern- und Fork-Verlauf 0 ★ / 5 ⇿
Wann jeder Stern und Fork hinzugefügt wurde, von GitHub erfasst und nach Tagen gruppiert. Das kumulierte Wachstum steht direkt über den täglichen Zugängen, aus denen es besteht, sodass beide gegeneinander lesbar sind: stetiger organischer Zuwachs sieht ganz anders aus als ein abrupter, kurzlebiger Ausschlag. Wo dieser Unterschied messbar ist, wird er als Wachstumsauthentizität ausgewiesen.
Jeder Punkt umfasst 3 Tage.
OpenSSF Scorecard 6.1 / 10
Unabhängige, werkzeugneutrale Sicherheitsbewertung durch das quelloffene OpenSSF Scorecard. Jede Prüfung honoriert eine Sicherheits-Praxis, nicht das Werkzeug eines bestimmten Anbieters. Prüfungen, die Scorecard nicht ermitteln konnte, sind mit k. A. markiert und vom Sicherheitswert ausgeschlossen (nie als null gezählt).
| 10 | Binary-Artifacts | no binaries found in the repo |
| k. A. | Branch-Protection | internal error: error during branchesHandler.setup: internal error: some github tokens can't read classic branch protection rules: https://github.com/ossf/scorecard-action/blob/main/docs/authentication/fine-grained-auth-token.md |
| 10 | CI-Tests | 30 out of 30 merged PRs checked by a CI test -- score normalized to 10 |
| 0 | CII-Best-Practices | no effort to earn an OpenSSF best practices badge detected |
| 3 | Code-Review | Found 1/3 approved changesets -- score normalized to 3 |
| 10 | Contributors | project has 4 contributing companies or organizations |
| 10 | Dangerous-Workflow | no dangerous workflow patterns detected |
| 10 | Dependency-Update-Tool | update tool detected |
| 0 | Fuzzing | project is not fuzzed |
| 10 | License | license file detected |
| 10 | Maintained | 30 commit(s) and 1 issue activity found in the last 90 days -- score normalized to 10 |
| k. A. | Packaging | packaging workflow not detected |
| 6 | Pinned-Dependencies | dependency not pinned by hash detected -- score normalized to 6 |
| 0 | SAST | SAST tool is not run on all commits -- score normalized to 0 |
| 10 | Security-Policy | security policy file detected |
| 0 | Signed-Releases | Project has not signed or included provenance with any releases. |
| 0 | Token-Permissions | detected GitHub workflow tokens with excessive permissions |
| 8 | Vulnerabilities | 2 existing vulnerabilities detected |
Direkte Abhängigkeiten 9
| Registry | Paket | Versionsvorgabe | Manifest |
|---|---|---|---|
| Go | github.com/Masterminds/sprig/v3 | v3.3.0 | go.mod |
| Go | github.com/ghodss/yaml | v1.0.0 | go.mod |
| Go | github.com/giantswarm/microerror | v0.4.1 | go.mod |
| Go | github.com/goccy/go-yaml | v1.19.2 | go.mod |
| Go | github.com/google/go-cmp | v0.7.0 | go.mod |
| Go | github.com/russross/blackfriday/v2 | v2.1.0 | go.mod |
| Go | github.com/spf13/cobra | v1.10.2 | go.mod |
| Go | k8s.io/apiextensions-apiserver | v0.36.3 | go.mod |
| Go | k8s.io/apimachinery | v0.36.3 | go.mod |
Alle Abhängigkeiten 38
Vollständig aufgelöster Abhängigkeitssatz aus dem GitHub-Abhängigkeitsgraphen: 9 direkte und 29 indirekte (transitive) Pakete. Die transitive Hülle ist vollständig, wenn das Repository eine Lockfile eincheckt.
| Registry | Paket | Version | Beziehung |
|---|---|---|---|
| Go | github.com/ghodss/yaml | v1.0.0 | direkt |
| Go | github.com/giantswarm/microerror | v0.4.1 | direkt |
| Go | github.com/goccy/go-yaml | v1.19.2 | direkt |
| Go | github.com/google/go-cmp | v0.7.0 | direkt |
| Go | github.com/masterminds/sprig/v3 | v3.3.0 | direkt |
| Go | github.com/russross/blackfriday/v2 | v2.1.0 | direkt |
| Go | github.com/spf13/cobra | v1.10.2 | direkt |
| Go | k8s.io/apiextensions-apiserver | v0.36.3 | direkt |
| Go | k8s.io/apimachinery | v0.36.3 | direkt |
| Go | dario.cat/mergo | v1.0.1 | indirekt |
| Go | github.com/fxamacker/cbor/v2 | v2.9.0 | indirekt |
| Go | github.com/go-logr/logr | v1.4.3 | indirekt |
| Go | github.com/google/uuid | v1.6.0 | indirekt |
| Go | github.com/huandu/xstrings | v1.5.0 | indirekt |
| Go | github.com/inconshreveable/mousetrap | v1.1.0 | indirekt |
| Go | github.com/json-iterator/go | v1.1.12 | indirekt |
| Go | github.com/masterminds/goutils | v1.1.1 | indirekt |
| Go | github.com/masterminds/semver/v3 | v3.3.1 | indirekt |
| Go | github.com/mitchellh/copystructure | v1.2.0 | indirekt |
| Go | github.com/mitchellh/reflectwalk | v1.0.2 | indirekt |
| Go | github.com/modern-go/concurrent | v0.0.0-20180306012644-bacd9c7ef1dd | indirekt |
| Go | github.com/modern-go/reflect2 | v1.0.3-0.20250322232337-35a7c28c31ee | indirekt |
| Go | github.com/shopspring/decimal | v1.4.0 | indirekt |
| Go | github.com/spf13/cast | v1.7.1 | indirekt |
| Go | github.com/spf13/pflag | v1.0.9 | indirekt |
| Go | github.com/x448/float16 | v0.8.4 | indirekt |
| Go | go.yaml.in/yaml/v2 | v2.4.3 | indirekt |
| Go | golang.org/x/crypto | v0.53.0 | indirekt |
| Go | golang.org/x/net | v0.55.0 | indirekt |
| Go | gopkg.in/check.v1 | v1.0.0-20201130134442-10cb98267c6c | indirekt |
| Go | gopkg.in/inf.v0 | v0.9.1 | indirekt |
| Go | gopkg.in/yaml.v2 | v2.4.0 | indirekt |
| Go | k8s.io/klog/v2 | v2.140.0 | indirekt |
| Go | k8s.io/kube-openapi | v0.0.0-20260317180543-43fb72c5454a | indirekt |
| Go | k8s.io/utils | v0.0.0-20260210185600-b8788abfbbc2 | indirekt |
| Go | sigs.k8s.io/json | v0.0.0-20250730193827-2d320260d730 | indirekt |
| Go | sigs.k8s.io/randfill | v1.0.0 | indirekt |
| Go | sigs.k8s.io/structured-merge-diff/v6 | v6.3.3 | indirekt |
Abhängigkeits-Advisories 2
Dieses Repository veröffentlicht kein vom Index auflösbares Paket, daher wurde sein eigener Abhängigkeitsgraph bewertet – 38 Pakete, darunter auch Entwicklungs- und Test-Pins, die nie ausgeliefert werden: 2 tragen bekannte Advisories, davon 0 direkte.
| Paket | Version | Beziehung | Schweregrad | Advisories | Behoben in |
|---|---|---|---|---|---|
| golang.org/x/crypto | v0.53.0 | indirekt | unbekannt | 1 | — |
| golang.org/x/net | v0.55.0 | indirekt | unbekannt | 1 | 1.27.0-rc.3 |
Ein Advisory bedeutet, dass die im Abhängigkeitsgraphen erfasste Version in den betroffenen Bereich eines Advisories fällt. Erreichbarkeit wird nicht analysiert, und der Graph enthält Entwicklungs- und Test-Pins — ein Fund kann das Werkzeug betreffen und nicht die ausgelieferte Software.
JSON-Rohbericht maschinenlesbar
Feedback
Stimmt etwas in diesem Bericht nicht, oder gibt es Gedanken dazu? Falsche Messungen, übersehene Tools, Ideen, Fragen — alles ist willkommen. Jede Nachricht wird gelesen und beantwortet.
Bewertungen sind Signale, keine Garantien. Sie spiegeln öffentlich sichtbare Praxis auf GitHub wider — kein Code-Audit und keine Sicherheitsgarantie.
Fehlende Daten werden ausgeschlossen und die Gewichte neu normiert, nie als null bewertet. Die Methodik ist versioniert und offen: Metriken v2.10.0, Schema v0.31.0 — vollständige Methodik · Metriken-Wiki.
Wie ein einzelnes Ergebnis im Gesamtregister steht: aggregierte Statistiken — Go.