Skip to content

docs: add catalog schema reference - #98

Open
DevOpsAIguru123 wants to merge 14 commits into
mainfrom
agentic-devops-daily-20260812-schema-docs
Open

docs: add catalog schema reference#98
DevOpsAIguru123 wants to merge 14 commits into
mainfrom
agentic-devops-daily-20260812-schema-docs

Conversation

@DevOpsAIguru123

@DevOpsAIguru123 DevOpsAIguru123 commented Aug 12, 2026

Copy link
Copy Markdown
Owner

Summary

  • Add docs/catalog-schema.md as the validator-backed catalog schema reference.
  • Link it from README, CONTRIBUTING, scoring, and safety docs.
  • Record the documentation addition in CHANGELOG.
  • Add regression tests that keep the schema reference aligned with validator allowlists for required fields, categories, artifact types, maturity values, and evaluation labels.
  • Maintainer refresh on 2026-08-13: extend the schema-reference regression tests to cover all validator enum constants, including action levels, human approval values, and evidence tracing values.
  • Maintainer refresh on 2026-08-13: clarify official-vs-community category provenance rules in the schema reference and add a regression test so contributor guidance does not disappear.
  • Maintainer refresh on 2026-08-28: add a minimal catalog entry template and template review checklist with safe defaults, top-level list placement, credential-scoping guidance, and label-to-score reminders.
  • Maintainer refresh on 2026-08-28: add a source verification checklist for reachability, freshness, tool-surface, credential-boundary, and safety-signal checks, with regression coverage so the review guidance remains documented.
  • Maintainer refresh on 2026-08-29: add a catalog evidence capture worksheet for PR bodies, including canonical source, reachability, freshness, tool surface, credential boundary, safety signals, harmless GitHub metadata commands, and no-secret reminders.
  • Maintainer refresh on 2026-08-29: add regression tests that keep the operator safety checklist linked from README, CONTRIBUTING, and the safety model, and preserve the core safety controls and scorecard preflight fields.
  • Maintainer refresh on 2026-08-30: document catalog identity and duplicate-handling rules for unique names, unique URLs, canonical sources, single-row use-case handling, and separate documentation versus runnable artifact rows; add regression coverage for the guidance.
  • Maintainer refresh on 2026-08-30: document README synchronization rules for catalog changes, covering Recently added, catalog section tables, intro quick picks, top-picks guidance, and the README count check; add regression coverage so this contributor guidance stays present.
  • Maintainer refresh on 2026-08-31: document the automated GitHub freshness audit workflow, including report paths, stale/archived warning handling, non-GitHub manual reachability checks, and regression coverage for the guidance.
  • Maintainer refresh on 2026-09-01: add a risk-notes writing guide with concrete credential-boundary, write/telemetry-risk, dry-run-first, approval, and missing-evidence guidance; add regression coverage so the guidance stays documented.
  • Maintainer refresh on 2026-09-01: add deprecation/removal guidance for archived, deprecated, unreachable, unsafe, or superseded catalog entries, with regression coverage so obsolete rows are not kept just to preserve README counts.

Validation

  • python3 scripts/sync_readme_counts.py --check
  • python3 scripts/sync_catalog_json.py --check
  • python3 scripts/validate_repos_yaml.py
  • python3 -m pytest -q (host Python lacked pytest, so the run used .venv after installing -e '.[dev]')
  • git diff --check

Results on 2026-09-01: README counts in sync for 80 entries / 15 sections, catalog JSON in sync for 8 skill sources, catalog validation passed for 80 entries, git diff whitespace check passed, and 169 tests passed.

Risk

Docs and tests only. No catalog entries, credentials, infrastructure, workflow files, or generated counts changed.

Maintainer refresh on 2026-08-12, 2026-08-13, 2026-08-28, 2026-08-29, 2026-08-30, 2026-08-31, and 2026-09-01: updated existing daily PR instead of creating a duplicate; latest refresh adds deprecation/removal guidance for stale or superseded entries.

@sonarqubecloud

sonarqubecloud Bot commented Sep 1, 2026

Copy link
Copy Markdown

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant