Skip to main content

Supervaizer Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

TODOโ€‹

  • Review and test feature/data-persistance
  • Complete feature/smartinstall implementation
  • Fix receive_human_input
  • Test and fix deploy

Unreleasedโ€‹

[0.10.1]โ€‹

Changedโ€‹

  • ๐Ÿ Python 3.13 Support - Added Python 3.13 compatibility
    • Updated package classifiers to include Python 3.13
    • Build process now uses Python 3.13 for wheel generation
    • CI test matrix includes Python 3.13
    • Wheels built with Python 3.13 are compatible with both Python 3.12 and 3.13

[0.10.0]โ€‹

Addedโ€‹

  • ๐Ÿš€ Cloud Deployment CLI - Complete automated deployment system for Supervaizer agents

    • Full implementation of RFC-001: Cloud Deployment CLI
    • Support for three major cloud platforms:
      • Google Cloud Run with Artifact Registry and Secret Manager
      • AWS App Runner with ECR and Secrets Manager
      • DigitalOcean App Platform
    • New deployment commands:
      • supervaizer deploy plan - Preview deployment actions before applying
      • supervaizer deploy up - Deploy to cloud platform with automated build, push, and verification
      • supervaizer deploy down - Tear down deployment and clean up resources
      • supervaizer deploy status - Check deployment status and health
      • supervaizer deploy local - Local Docker testing with docker-compose
      • supervaizer deploy clean - Clean up deployment artifacts and state
    • Automated Docker Workflow: Build โ†’ Push โ†’ Deploy โ†’ Verify
    • Secret Management: Secure handling of API keys and RSA keys via cloud provider secret stores
    • Health Verification: Automatic health checks at /.well-known/health endpoint
    • Idempotent Deployments: Safe create/update operations with rollback on failure
    • Local Testing: Full Docker Compose environment for pre-deployment testing
    • See Local Testing Documentation for details
  • Agent Instructions Template - New HTML page served by FastAPI for Supervaize integration instructions

    • Accessible at /admin/supervaize-instructions
    • Provides step-by-step setup guide for agents
  • Version Check Utility - Automatic check for latest Supervaizer version

    • Helps users stay up-to-date with latest features and fixes
    • Located in supervaizer.utils.version_check
  • Enhanced Admin Interface

    • New agents listing page with grid view
    • Improved agent detail views
    • Better navigation and UI consistency

Changedโ€‹

  • ๐Ÿ”„ Protocol Unification - Removed ACP protocol in favor of unified A2A protocol

    • Removed src/supervaizer/protocol/acp/ directory and all ACP-specific code
    • Removed acp_endpoints parameter from Server class
    • Removed ACP route registration and test files
    • Updated all documentation to reflect A2A-only support
    • The A2A protocol has evolved to incorporate features from multiple agent communication standards, including the former ACP
    • All A2A protocol links updated to https://a2a-protocol.org/
    • Breaking Change: acp_endpoints parameter no longer accepted in Server initialization
  • ๐Ÿ“ฆ Dependency Optimization - Cloud SDKs moved to optional dependencies

    • Base package size significantly reduced
    • Cloud deployment dependencies now optional: pip install supervaizer[deploy]
    • Optional deploy group includes: boto3, docker, google-cloud-artifact-registry, google-cloud-run, google-cloud-secret-manager, psutil
    • Removed unused pymongo dependency
    • Updated dependency versions for better compatibility
  • Improved Error Handling - Enhanced API error responses with better context

  • Documentation Updates

    • Added comprehensive deployment documentation
    • Updated model reference documentation
    • Improved README with deployment examples
    • Updated PROTOCOLS.md to focus on unified A2A protocol
    • Added Protocol Evolution section explaining ACP merger

Fixedโ€‹

  • API documentation errors corrected
  • Improved type hints for agent_parameters and case_ids in job.py
  • Health logging optimized in A2A routes

Unit Tests Resultsโ€‹

StatusCount
โœ… Passed415
๐Ÿค” Skipped6
๐Ÿ”ด Failed0
โฑ๏ธ in50.56s

Migration Notesโ€‹

  • ACP Protocol Removal: If your code uses acp_endpoints=True parameter, remove it from Server initialization. The A2A protocol now provides unified agent communication.
  • If you need deployment features, install with: pip install supervaizer[deploy]
  • For development, install with: pip install supervaizer[dev,deploy]
  • No other breaking changes to existing APIs or functionality

[0.9.8]โ€‹

Addedโ€‹

  • Parameter Validation System: Added comprehensive parameter validation for job creation with clean error messages
    • New validate_parameters() method in ParametersSetup class for agent parameter validation
    • New validate_method_fields() method in AgentMethod class for job field validation
    • Two separate validation endpoints for different validation needs:
      • /validate-agent-parameters - Validate agent configuration parameters (secrets, API keys, etc.)
      • /validate-method-fields - Validate job input fields against method definitions
    • Support for validating both job fields and encrypted agent parameters
    • Clean error messages with specific details about invalid parameter types and missing required parameters

Fixedโ€‹

  • Execution of supervaizer start was not maintaining the main namespace so the fastapi server was never starting. Replaced execution by sub-process.
  • Type of agent.choice. #TODO: test and decide which to keep (list[str] or list [tuple[str,str]])
  • When supervisor_account is provided, A2A endpoints are automatically activated, because Supervaize needs to be able to trigger the healthchecks. -export_openapi.py tool to generate openapi.json (for docusaurus documentation) - automation in docusaurus to do.

Changedโ€‹

  • Parameter Validation System: Refactored to provide separate validation endpoints for different concerns

    • Agent Parameters: Now validated separately through /validate-agent-parameters endpoint
    • Method Fields: Now validated separately through /validate-method-fields endpoint
    • Clean Architecture: Removed legacy endpoint for cleaner, more focused API design
    • Code Deduplication: Eliminated redundant validation code in job start endpoints
    • Clearer Separation: Agent configuration validation vs. job input validation are now distinct operations
  • pytest does not run with coverage by default (change in pyproject.toml)

Unit tests resultsโ€‹

StatusCount
โœ… Passed308
๐Ÿค” Skipped6

[0.9.6]โ€‹

  • Public release to Pypi
  • Fixed the gihut workflows
  • Improve README.md

[0.9.5]โ€‹

Fixedโ€‹

  • Setup : missing py.typed in pyproject
  • clarified public_url (replaced registration_host by public_url)
  • changed "supervaizer install" to "supervaizer scaffold"

Addedโ€‹

  • gen_model_docs.py: tool for documentation generation - see disclaimer

Unit tests resultsโ€‹

StatusCount
โœ… Passed277
๐Ÿค” Skipped6

[0.9.4]โ€‹

Addedโ€‹

  • CICD : release, deploy
  • gen_model_docs.py : to generate the documentation of the models.

Changedโ€‹

  • Moved "example" to src/supervaizer
  • Improved and Moved some documentation to docs
  • Added python-package.yml github action, triggered on push / PR of "develop" branch

[0.9.3]โ€‹

Addedโ€‹

  • Data persistence with tinyDB
  • Admin UI with fastAdmin
  • Dynamic content on:
    • Server page
    • Agent
    • Jobs
    • Cases
  • Add persisted data to job status check.

Changedโ€‹

  • Paramater.to_dict : override to avoid storing secrets.
  • Removed Case Nodes
  • Improved test coverage : accounts, admin/routes,

Unit tests resultsโ€‹

StatusCount
๐Ÿค” Skipped6
โš ๏ธ Failed0
โœ… Passed281

Test Coverage : Test Coverage

Emoji Legend
๐ŸŒ… Template๐Ÿน Service๐Ÿ‘” Models
๐Ÿ› Bug๐Ÿ›ฃ๏ธ Infrastructure/CICD๐Ÿ”Œ API
๐Ÿ’ผ Admin๐Ÿ“– Documentation๐Ÿ“ฐ Events
๐Ÿงช Tests๐Ÿง‘โ€๐ŸŽจ UI/Style๐ŸŽผ Controller

Uploaded on 2026-01-25 14:28:59