Upgrade Guides

Use this checklist whenever you bump GL AIP or deploy a new version of the AIP backend.

When to use this guide: Plan upgrades, communicate timelines, or document migrations between AIP releases.

Who benefits: Release managers, platform engineers, and PMs coordinating customer rollouts.

ℹ️ Current versions
AIP SDK: 0.0.10
AIP Platform backend: 0.1.53

Latest platform release notes live at https://github.com/GDP-ADMIN/ai-agent-platform/releases. SDK release notes are tracked in the Changelog.

Capture breaking changes or behavioural updates before upgrading.

Back up agents, tools, and MCP configs as JSON/YAML if you manage them manually.

On each machine or runner execute:

CLI

aip update

Run basic checks to ensure functionality:

Pull the corresponding AIP release and restart services.

Run one workflow that exercises each connector you depend on.

Note the versions installed and any follow-up tasks (e.g., feature flag toggles, configuration updates).

Tips

Keep a copy of exported agent/tool JSON in version control; it simplifies rollback and lets you diff changes across upgrades.
Automate aip update via CI jobs so runners stay in sync with PyPI releases.
When the REST API introduces new endpoints or payloads, the REST API Reference is updated automatically and should be consulted for schema details.

Future breaking changes will re-use this page—add concise “Before / After” code snippets when they land so the checklist stays actionable.

Configuration management guide — Export/import workflows for pre- and post-upgrade backups.
Automation & scripting — Schedule aip update checks and regression runs.
Agents guide — Validate run history and streaming behaviour after upgrades.
Security & privacy — Confirm PII mappings and token scopes did not regress.