Back to Guides

/gcloud-kit:health

Run a comprehensive health check across all services to identify missing documents, placeholder content, and compliance issues.

Overview

Scans your entire G-Cloud service portfolio and produces a health report with per-service status, placeholder detection, character limit validation, certificate expiry warnings, and cross-document consistency checks. Outputs a console summary and a structured JSON file for CI/CD integration.

Usage

/gcloud-kit:health

Arguments: None required. Scans all services in the services/ directory.

Prerequisites

None. This command scans whatever exists and reports on gaps.

Output

  • Console health report with per-service table and recommendations
  • docs/health.json — structured health data

What it does

  1. Scans all service directories under services/
  2. Checks supplier-level documents (supplier profile, declaration)
  3. Per-service checks:
    • Missing documents — flags absent service-design, sdd, pricing, security
    • Placeholder detection — finds [TODO], [TBD], [PLACEHOLDER], [ENTER, [YOUR, [INSERT patterns
    • Character limit violations — validates service name (100 chars), summary (500 chars / 50 words), features and benefits (100 chars each, 10 max)
    • Certificate expiry — scans for dates near expiry/renewal keywords and flags certificates expiring within 6 months
    • Lot consistency — checks lot matches across service-design and sdd
  4. Calculates a portfolio health score (0-100) weighted across completeness, placeholders, limits, certificates, and consistency
  5. Classifies issues by severity (critical, high, medium, low)
  6. Generates actionable recommendations mapped to specific /gcloud-kit: commands
  7. Writes docs/health.json with structured results

Health score thresholds

ScoreStatusMeaning
90-100HEALTHYReady for submission review
70-89NEEDS ATTENTIONFix issues before submission
50-69AT RISKSignificant work remaining
0-49CRITICALMajor gaps, not submission-ready

Related commands