Skip to content

About

Resources

Code of conduct

Security policy

Stars

1 star

Watchers

1 watching

Forks

Repository files navigation

Google Cloud Radar

Real-time pre-release intelligence for Google APIs and Cloud services. Tracking unreleased method additions, schema changes, and breaking changes directly from the Google API Discovery Service before they appear in official release notes.

CI Live Site


Architecture

graph TD
    A[Google Discovery API] -->|Cron 5x Daily| B[scripts/update_disco.py]
    B --> C[discoveries/ Normalized ASTs]
    C --> D[scripts/diff_to_feed.py]
    D --> E[scripts/diff_preprocessor.py - AIP-180 Breaking Checks]
    E --> F[scripts/llm_client.py - Vertex AI Gemini]
    F --> G[data/ Structured JSON Changes + Index]
    G --> H[scripts/correlate_releases.py - Lead Time Delta]
    H --> I[scripts/seed_prod_firestore.py - Cloud Firestore]
    I --> J[scripts/dispatch_email_alerts.py - Resend Transactional Alerts]
    G --> K[web/ - Astro 5 Web Application & MiniSearch]
    K --> L[Firebase Hosting: google-cloud-radar.com]
Loading

Quick Start

1. Web Application (web/)

cd web
npm install
npm run dev        # Astro local dev server at http://localhost:4321
npm run dev:all    # Astro + Local Zero-Java Mock Firestore server

See web/README.md for frontend architecture, search engine, and alert modal deep-linking.

2. Python Pipeline & Email Alerts (scripts/)

pip install -r requirements.txt
pytest tests/

# Preview AST diffs without calling Gemini
python scripts/diff_to_feed.py --dry-run

# Test email dispatch for a specific change
python scripts/dispatch_email_alerts.py --test-email dev@example.com --slug 2026-08-29-aiplatform-v1beta1

See scripts/README.md for CLI options, prompt tuning, release correlation, and email dispatch.


Repository Structure

.
├── discoveries/          # Normalized Discovery JSON ASTs (46+ monitored GCP services)
├── data/                 # Structured JSON change documents (changes/*.json) & index.json
├── scripts/              # Python ingestion, AST diffing, Gemini analysis, Firestore sync & email dispatch
│   └── README.md         # Pipeline CLI usage & script documentation
├── terraform/            # Terraform IaC: Hosting, Firestore rules, Identity Platform & IAM
├── tests/                # Pytest / Unittest test suite for diffing, taxonomy & email alerts
├── web/                  # Astro 5 static web application & client components
│   └── README.md         # Web app architecture & emulator setup
└── AGENTS.md             # AI coding agent context and architectural invariants

Documentation & Architecture

Guide Description
Web Frontend Guide Astro 5 architecture, page routes, mock Firestore dev server (dev:all), and styling tokens.
Data Pipeline Guide CLI commands, AST diffing engine, Gemini prompt tuning, and release note correlation.
Security Policy Vulnerability disclosure guidelines, response commitments, and defense-in-depth architecture.
AI Agent Context Architectural mental model, core engineering invariants (AIP-180 rules, 90-day benchmark scope), and subsystems map.

Deployment

  • Automated: Pushes to main trigger .github/workflows/deploy-web.yml to build and deploy to Firebase Hosting.
  • Manual:
    cd web
    npm run build
    npx firebase-tools deploy --only hosting --project gcp-cloud-radar

Acknowledgments

This project builds upon the foundational Discovery document synchronization tooling from Google's googleapis/discovery-artifact-manager.


Security & License

  • Security: See SECURITY.md for vulnerability reporting and security practices.
  • License: Apache 2.0 · See CODE_OF_CONDUCT.md for community participation guidelines.

About

Resources

Code of conduct

Security policy

Stars

1 star

Watchers

1 watching

Forks

Used by

Contributors

Languages