Skip to content

docs: add catalog schema reference - #98

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

DevOpsAIguru123 wants to merge 36 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 schema-reference documentation additions in CHANGELOG.
  • Add regression tests that keep the schema reference aligned with validator allowlists and safety-scoring guidance.
  • Maintainer refreshes from 2026-08-13 through 2026-09-12 expanded the schema reference with official-vs-community provenance, entry templates, source verification, evidence worksheets, safety checklist link coverage, identity/duplicate rules, README sync, freshness audits, risk notes, deprecation/removal handling, change decisions, external-index guidance, safety-score evidence rules, hosted MCP credential boundaries, PR reviewer gates, public-safe metadata, instruction boundaries, evaluation environments, tool permission/consent, telemetry/retention, credential lifecycle, dependency/supply-chain, runtime isolation, approval/change-control, and incident automation guidance.
  • Maintainer refresh on 2026-09-13: add compliance evidence and audit export guidance for compliance/GRC agents, covering control scope, evidence stores, read-only audit exports, remediation actions, actor identity, retention boundaries, audit trails, and public-safe synthetic compliance examples.
  • Maintainer refresh on 2026-09-13: add data platform operations and data movement guidance, covering metadata lookup, production queries, writes/backfills/deletes, dataset scope, masking, retention, audit evidence, rollback, and public-safe synthetic warehouse examples.
  • Maintainer refresh on 2026-09-14: add MLOps model operation and evaluation guidance, covering experiment lookup, model training, registry promotion, endpoint deployment, feature-store writes, prompt/eval data exposure, rollback, audit evidence, and public-safe synthetic model-operation examples.
  • Maintainer refresh on 2026-09-14: add secrets and identity operations guidance, covering secret reveal/rotation/revocation, principal and policy changes, redaction and retention boundaries, approval evidence, rollback, and public-safe synthetic identity examples.

Validation

  • python3 scripts/sync_readme_counts.py --check
  • python3 scripts/sync_catalog_json.py
  • python3 scripts/validate_repos_yaml.py
  • /Users/tuximac/projects/awesome-agentic-devops/.venv/bin/python -m pytest -q
  • git diff --check

Results on 2026-09-14 latest refresh: README counts in sync for 80 entries / 15 sections, catalog JSON in sync for 8 skill sources, catalog validation passed for 80 entries, targeted secrets/identity schema-regression test passed, full pytest passed with 188 tests, and git diff whitespace check passed. The existing local .venv provided pytest for the validation run.

Risk

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

Maintainer refresh on 2026-09-14: updated existing daily PR instead of creating a duplicate; latest refresh adds secrets and identity operations guidance and keeps the schema-reference reviewer gate current for secret reveal/rotation/revocation, principal and policy changes, redaction and retention boundaries, approval evidence, rollback, and public-safe synthetic identity examples.

tuximac and others added 30 commits August 12, 2026 07:04
@sonarqubecloud

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