giantswarm / crd-docs-generator
Tooling to create user-friendly reference documentation for Kubernetes Custom Resource Definitions (CRDs)
giantswarm/crd-docs-generator має індекс здоров’я 87 зі 100, що відповідає смузі «Відмінний». Найвищий показник — AI Readiness (97/100), найнижчий — Community & Adoption (45/100). Останнє оновлення було 7 днів тому. Більшість нещодавньої роботи виконує один учасник.
Індекс здоров'я програмного забезпечення
Метрики згруповано у зважені категорії на шкалі 1–100. Загальна оцінка починається як їхнє зважене середнє, відкаліброване за розподілом публічного реєстру, тож діапазони мають перцентильний зміст; коли публічні дані активують Політику юрисдикцій високого ризику, рейтинг коригується й отримує верхню межу 34 («У зоні ризику»).
Профіль оцінок
Кожна вісь — окрема категорія. Форма важить більше, ніж середнє: здоровий об'єкт заповнює всю фігуру, тоді як профіль із піками та провалами означає, що сила в одному вимірі маскує ризик в іншому.
Зважений загальний бал 73 калібровано до 87 за шкалою опублікованого індексу (калібрування реєстру 2026-08-02).
Власність
За цим репозиторієм стоїть організація — спільна, підзвітна опіка, здатна пережити будь-якого окремого мейнтейнера.
Пакетні екосистеми
| Реєстр | Пакет | Версія | Завантажень / міс | Версії | Остання публікація |
|---|---|---|---|---|---|
| Go | github.com/giantswarm/crd-docs-generator | v0.12.32 | - | 56 | 7 днів тому |
Метрики за категоріями
Життєздатність
Чи живий проєкт — чи пишеться код і чи виходять релізи?
Активність розробки
Як обчислюється оцінка
| 36/36 | Свіжість push — останній push 7 дн. тому |
| 27/36 | Ритм комітів — 39/52 тижнів із комітами |
| 18/18 | Обсяг комітів — 109 комітів за останній рік |
| 10/10 | OpenSSF Scorecard: Maintained — 30 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 10 |
Використані вхідні дані
| commits_last_year | 109 |
| human_commit_share | 0,19 |
| days_since_last_push | 7 |
| active_weeks_last_year | 39 |
Дисципліна релізів
Як обчислюється оцінка
| 27/27 | Випускає релізи — опубліковано 56 релізів |
| 36/36 | Свіжість релізів — останній реліз 7 дн. тому |
| 27/27 | Ритм релізів — реліз кожні ~1,1 дн. |
| 0/10 | OpenSSF Scorecard: Signed-Releases — Project has not signed or included provenance with any releases. |
Використані вхідні дані
| releases_count | 56 |
| latest_release_tag | v0.12.32 |
| releases_from_tags | ні |
| days_since_latest_release | 7 |
| mean_days_between_releases | 1,1 |
Спільнота та впровадження
Чи має проєкт користувачів, завантаження, увагу та влаштовані умови для контриб’юторів?
Популярність і впровадження
Як обчислюється оцінка
| 23/60 | Зірки — 27 зірок |
| 5.8/25 | Форки — 6 форків |
| 5/15 | Спостерігачі — 9 спостерігачів |
Використані вхідні дані
| forks | 6 |
| stars | 27 |
| watchers | 9 |
| growth_state | unverified |
| growth_factor_pct | 100 |
| growth_unverified_reason | no_history |
Здоров'я спільноти
Як обчислюється оцінка
| 22.5/22.5 | README |
| 22.5/22.5 | Ліцензія — визнана ліцензія (Apache-2.0) |
| 0/18 | Настанови CONTRIBUTING |
| 0/13.5 | Кодекс поведінки |
| 0/7.2 | Шаблон issue |
| 6.3/6.3 | Шаблон PR |
Використані вхідні дані
| has_readme | так |
| has_license | так |
| readme_badges | 1 |
| has_contributing | ні |
| has_issue_template | ні |
| has_code_of_conduct | ні |
| readme_badge_services | circleci.com |
| has_pull_request_template | так |
Сталість та врядування
Чи переживе проєкт своїх людей — бас-фактор, реактивність, хто за ним стоїть і як супроводжуються пакети?
Стійкість мейнтейнерів (бас-фактор)
Як обчислюється оцінка
| 9/54 | Бас-фактор — на 1 контриб’ютор(ів) припадає половина всіх комітів |
| 8.6/22.5 | Розподіл комітів — головний контриб’ютор — автор 62% комітів |
| 13.5/13.5 | Широта контриб’юторів — 11 контриб’юторів |
| 10/10 | OpenSSF Scorecard: Contributors — project has 4 contributing companies or organizations |
Використані вхідні дані
| bus_factor | 1 |
| contributors_sampled | 11 |
| top_contributor_share | 0,616 |
Реактивність на issue та PR
Як обчислюється оцінка
| 36.8/42 | Вирішення issue — закрито 88% issue |
| 28.7/30 | Прийняття PR — злито 426/446 вирішених PR |
| 0/13 | Newcomer PR acceptance — за 30 дн. не вирішено жодного PR від новачка |
| 0/15 | OpenSSF Scorecard: Code-Review — Found 0/2 approved changesets -- score normalized to 0 |
Використані вхідні дані
| merged_prs | 426 |
| open_issues | 1 |
| closed_issues | 7 |
| prs_merged_7d | 0 |
| prs_decided_7d | 0 |
| prs_merged_30d | 2 |
| prs_decided_30d | 2 |
| 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 |
Власність та опіка
Як обчислюється оцінка
| 30/30 | Підтримка власника — у власності організації |
| 20/20 | Верифікований домен |
| 15.6/25 | Охоплення власника — 148 підписників у giantswarm |
| 25/25 | Послужний список — 1 187 публічних репозиторіїв, вік облікового запису ~12 р. |
Використані вхідні дані
| followers | 148 |
| owner_type | Organization |
| is_verified | так |
| owner_login | giantswarm |
| public_repos | 1 187 |
| account_age_days | 4 511 |
Супровід пакетів
Як обчислюється оцінка
| 25/25 | Опубліковано й доступно — 1 пакет(ів) у go |
| 35/35 | Свіжість публікацій — остання публікація 7 дн. тому |
| 20/20 | Історія версій — 56 опублікованих версій |
| 20/20 | Не застарілий — активний, не deprecated і не yanked |
Використані вхідні дані
| packages | github.com/giantswarm/crd-docs-generator |
| ecosystems | go |
| any_deprecated | ні |
| min_days_since_publish | 7 |
Інженерна якість
Чи наявні базові інженерні практики та документація?
Інженерні практики
Як обчислюється оцінка
| 24/24 | Процеси CI — 8 процес(ів) CI |
| 24/24 | Наявні тести |
| 16/16 | Конфігурація лінтера |
| 9.6/9.6 | Pre-commit-хуки |
| 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 |
Використані вхідні дані
| has_ci | так |
| has_tests | так |
| has_editorconfig | ні |
| has_linter_config | так |
| has_precommit_config | так |
Документація
Як обчислюється оцінка
| 30/30 | README |
| 0/25 | Каталог документації |
| 0/15 | Сайт документації / домашня сторінка |
| 10/10 | Опис репозиторію |
| 10/10 | Теми — 3 тем |
| 0/10 | Wiki |
Використані вхідні дані
| topics | documentation, documentation-generator, kubernetes |
| has_wiki | ні |
| homepage | — |
| docs_site | — |
| has_readme | так |
| has_docs_dir | ні |
| has_description | так |
Безпека
Чи міцні видимі практики безпеки й ланцюга постачання, без непослабленої пов’язаності з юрисдикціями високого ризику?
Стан безпеки
Як обчислюється оцінка
| 7.5/7.5 | Binary-Artifacts — no binaries found in the repo |
| 0/7.5 | Branch-Protection — немає даних |
| 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 |
| 0/7.5 | Code-Review — Found 0/2 approved changesets -- score normalized to 0 |
| 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 | Ліцензія — license file detected |
| 7.5/7.5 | Maintained — 30 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 10 |
| 0/5 | Packaging — немає даних |
| 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.8/7.5 | Vulnerabilities — 1 existing vulnerabilities detected |
Використані вхідні дані
| source | openssf_scorecard |
| checks_evaluated | 16 |
| scorecard_version | v5.5.0 |
| checks_inconclusive | 2 |
| scorecard_aggregate | 5,9 |
Сповіщення про залежності
Як обчислюється оцінка
| 35/35 | Прямі залежності без відомих сповіщень — жодна пряма залежність не має відомих сповіщень |
| 0/25 | Непрямі залежності без відомих сповіщень — транзитивний набір не відокремлюється від залежностей розробки й тестування в цьому обсязі |
| 0/40 | Немає задавнених сповіщень — жодне сповіщення не має дати публікації |
Використані вхідні дані
| source | osv |
| advisories | 0 |
| affected_packages | 0 |
| assessed_packages | 37 |
| unassessed_packages | 0 |
| affected_by_severity | none |
| direct_affected_packages | 0 |
Готовність до ШІ
Наскільки репозиторій оснащений для розробки та супроводу за участі ШІ-агентів? Має свідомо малу вагу (4%): агентний інструментарій — реальний сигнал супроводу, але репозиторій без нього все одно може отримати 100/100.
Контекст і настанови для агентів
Як обчислюється оцінка
| 45/45 | Інструкції для агентів — .cursor/rules/configuration.mdc, .cursor/rules/zz_generated.base-llm-rules.mdc, .cursor/rules/zz_generated.go-llm-rules.mdc |
| 15/15 | Машиночитана документація (llms.txt) — llms.txt опубліковано на сайті проєкту (https://docs.giantswarm.io/llms.txt) |
| 0/40 | Читабельна історія комітів — немає даних |
Використані вхідні дані
| has_llms_txt | так |
| llms_txt_url | https://docs.giantswarm.io/llms.txt |
| legible_history_share | — |
| 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 |
Як обчислюється оцінка
| 18/18 | Розгортання однією командою — Makefile |
| 22/22 | Автоматизовані тести |
| 11/11 | Конфігурація лінтера / форматера |
| 11/11 | Статична перевірка типів — Go (статично типізована) |
| 10/10 | Відтворюване середовище — Dockerfile, lockfile |
| 8/10 | Підтверджена практика роботи з агентами — 4 з останніх 100 комітів створено агентом або з його зазначенням |
| 8/8 | Автоматизоване супроводження — 59 з останніх 100 комітів — автоматичні оновлення залежностей |
| 6/10 | OpenSSF Scorecard: Pinned-Dependencies — dependency not pinned by hash detected -- score normalized to 6 |
Використані вхідні дані
| has_nix | ні |
| has_tests | так |
| lockfiles | go.sum |
| has_dockerfile | так |
| typed_language | так |
| bootstrap_files | Makefile |
| has_devcontainer | ні |
| has_linter_config | так |
| typecheck_configs | — |
| agent_commit_share | 0,04 |
| toolchain_manifests | go.mod |
| dependency_bot_commit_share | 0,59 |
Читабельність коду для моделей
Як обчислюється оцінка
| 45/45 | Типізований код — Go (статично типізована) |
| 55/55 | Керовані розміри файлів — 0/18 файлів вихідного коду понад 60 КБ |
Використані вхідні дані
| primary_language | Go |
| largest_source_bytes | 8 141 |
| source_files_sampled | 18 |
| oversized_source_files | 0 |
Ключові факти
Попередження щодо збору даних
- Star history unavailable: GitHub GraphQL error: Resource not accessible by personal access token
Докладніше
Історія зірок і форків 0 ★ / 6 ⇿
Коли додано кожну зірку й форк — зібрано з GitHub і згруповано за днями. Кумулятивне зростання розміщено просто над денними додаваннями, з яких воно складається, тож їх видно одне проти одного: рівномірне органічне накопичення виглядає зовсім інакше, ніж різкий короткочасний сплеск. Там, де цю різницю можна виміряти, її подано як автентичність росту.
Кожна точка охоплює 5 днів.
OpenSSF Scorecard 5.9 / 10
Незалежна, не прив'язана до інструментів оцінка безпеки від відкритого проєкту OpenSSF Scorecard. Кожна перевірка винагороджує практику безпеки, а не інструмент конкретного постачальника. Перевірки, які Scorecard не зміг визначити, позначено н/д і виключено з оцінки безпеки (вони ніколи не зараховуються як нуль).
| 10 | Binary-Artifacts | no binaries found in the repo |
| н/д | 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 |
| 0 | Code-Review | Found 0/2 approved changesets -- score normalized to 0 |
| 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 0 issue activity found in the last 90 days -- score normalized to 10 |
| н/д | 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 |
| 9 | Vulnerabilities | 1 existing vulnerabilities detected |
Прямі залежності 9
| Реєстр | Пакет | Обмеження версії | Маніфест |
|---|---|---|---|
| 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.37.0 | go.mod |
| Go | k8s.io/apimachinery | v0.37.0 | go.mod |
Усі залежності 37
Повний розв'язаний набір залежностей із графа залежностей GitHub: 9 прямих і 28 непрямих (транзитивних) пакетів. Транзитивне замикання є повним, коли в репозиторії закомічено lockfile.
| Реєстр | Пакет | Версія | Зв'язок |
|---|---|---|---|
| Go | github.com/ghodss/yaml | v1.0.0 | пряма |
| Go | github.com/giantswarm/microerror | v0.4.1 | пряма |
| Go | github.com/goccy/go-yaml | v1.19.2 | пряма |
| Go | github.com/google/go-cmp | v0.7.0 | пряма |
| Go | github.com/masterminds/sprig/v3 | v3.3.0 | пряма |
| Go | github.com/russross/blackfriday/v2 | v2.1.0 | пряма |
| Go | github.com/spf13/cobra | v1.10.2 | пряма |
| Go | k8s.io/apiextensions-apiserver | v0.37.0 | пряма |
| Go | k8s.io/apimachinery | v0.37.0 | пряма |
| Go | dario.cat/mergo | v1.0.1 | непряма |
| Go | github.com/fxamacker/cbor/v2 | v2.9.1 | непряма |
| Go | github.com/go-logr/logr | v1.4.3 | непряма |
| Go | github.com/google/uuid | v1.6.0 | непряма |
| Go | github.com/huandu/xstrings | v1.5.0 | непряма |
| Go | github.com/inconshreveable/mousetrap | v1.1.0 | непряма |
| Go | github.com/json-iterator/go | v1.1.12 | непряма |
| Go | github.com/masterminds/goutils | v1.1.1 | непряма |
| Go | github.com/masterminds/semver/v3 | v3.3.1 | непряма |
| Go | github.com/mitchellh/copystructure | v1.2.0 | непряма |
| Go | github.com/mitchellh/reflectwalk | v1.0.2 | непряма |
| Go | github.com/modern-go/concurrent | v0.0.0-20180306012644-bacd9c7ef1dd | непряма |
| Go | github.com/modern-go/reflect2 | v1.0.3-0.20250322232337-35a7c28c31ee | непряма |
| Go | github.com/shopspring/decimal | v1.4.0 | непряма |
| Go | github.com/spf13/cast | v1.7.1 | непряма |
| Go | github.com/spf13/pflag | v1.0.10 | непряма |
| Go | github.com/x448/float16 | v0.8.4 | непряма |
| Go | go.yaml.in/yaml/v2 | v2.4.4 | непряма |
| Go | golang.org/x/net | v0.58.0 | непряма |
| Go | golang.org/x/text | v0.42.0 | непряма |
| Go | gopkg.in/inf.v0 | v0.9.1 | непряма |
| Go | gopkg.in/yaml.v2 | v2.4.0 | непряма |
| Go | k8s.io/klog/v2 | v2.140.0 | непряма |
| Go | k8s.io/kube-openapi | v0.0.0-20260721132016-d427ff9ee9ad | непряма |
| Go | k8s.io/utils | v0.0.0-20260626114624-be93311217bd | непряма |
| Go | sigs.k8s.io/json | v0.0.0-20250730193827-2d320260d730 | непряма |
| Go | sigs.k8s.io/randfill | v1.0.0 | непряма |
| Go | sigs.k8s.io/structured-merge-diff/v6 | v6.4.2 | непряма |
Сповіщення про залежності 0
Цей репозиторій не публікує пакета, який розпізнає індекс, тож оцінено його власний граф залежностей — 37 пакетів, серед яких є й піниї розробки та тестування, що ніколи не постачаються: 0 мають відомі сповіщення, з них 0 прямі.
Жодне відоме сповіщення не стосується оцінених залежностей.
Сповіщення означає, що версія, записана в графі залежностей, потрапляє в уражений діапазон. Досяжність не аналізується, а граф містить піниї розробки й тестування — знахідка може стосуватися інструментів, а не поставленого коду.
Звіт у форматі JSON машиночитний
Зворотний зв’язок
Помітили щось хибне у цьому звіті або маєте чим поділитися? Неправильні вимірювання, непомічені інструменти, ідеї, запитання — усе доречно. Кожне повідомлення читається й отримує відповідь.
Оцінки — це сигнали, а не гарантії. Вони відображають публічно видимі практики на GitHub — це не аудит коду й не гарантія безпеки.
Відсутні дані виключаються, а ваги перенормовуються — нуль за відсутність ніколи не ставиться. Методологія версіонована й відкрита: метрики v2.10.0, схема v0.34.0 — повна методологія · вікі метрик.
Як окремий результат виглядає на тлі всього реєстру: сукупна статистика — Go.