Release Python SDKs (a2ui-agent-sdk v0.3.1, a2ui-core v0.1.1)#1920
Release Python SDKs (a2ui-agent-sdk v0.3.1, a2ui-core v0.1.1)#1920jacobsimionato wants to merge 2 commits into
Conversation
There was a problem hiding this comment.
Code Review
This pull request introduces comprehensive documentation and workflows for releasing A2UI Python and TypeScript SDKs, including a new AI agent skill, a general package release guide, and a Python-specific publishing guide. It also bumps the versions and initializes changelogs for the a2ui_agent and a2ui_core Python packages. The review feedback highlights several instances of absolute local file URLs that leak local paths and will break for other users, suggesting they be converted to relative paths. Additionally, it recommends correcting a reference to a global changelog in the release guide to reflect the package-specific changelog structure.
| - Generic Release Guide & Policies: [development/docs/package_releases.md](file:///Users/jsimionato/development/a2ui_repos/release-oncall/A2UI/development/docs/package_releases.md) | ||
| - Python Technical Publishing Guide: [agent_sdks/python/docs/python_publishing.md](file:///Users/jsimionato/development/a2ui_repos/release-oncall/A2UI/agent_sdks/python/docs/python_publishing.md) | ||
| - TypeScript Technical Publishing Guide: [renderers/docs/web_publishing.md](file:///Users/jsimionato/development/a2ui_repos/release-oncall/A2UI/renderers/docs/web_publishing.md) |
There was a problem hiding this comment.
These links use absolute local file URLs (file:///Users/jsimionato/...) which will be broken for other users and leak local environment paths. They should be converted to relative paths.
| - Generic Release Guide & Policies: [development/docs/package_releases.md](file:///Users/jsimionato/development/a2ui_repos/release-oncall/A2UI/development/docs/package_releases.md) | |
| - Python Technical Publishing Guide: [agent_sdks/python/docs/python_publishing.md](file:///Users/jsimionato/development/a2ui_repos/release-oncall/A2UI/agent_sdks/python/docs/python_publishing.md) | |
| - TypeScript Technical Publishing Guide: [renderers/docs/web_publishing.md](file:///Users/jsimionato/development/a2ui_repos/release-oncall/A2UI/renderers/docs/web_publishing.md) | |
| - Generic Release Guide & Policies: [development/docs/package_releases.md](../../../development/docs/package_releases.md) | |
| - Python Technical Publishing Guide: [agent_sdks/python/docs/python_publishing.md](../../../agent_sdks/python/docs/python_publishing.md) | |
| - TypeScript Technical Publishing Guide: [renderers/docs/web_publishing.md](../../../renderers/docs/web_publishing.md) |
| - **General Release Guide**: [development/docs/package_releases.md](file:///Users/jsimionato/development/a2ui_repos/release-oncall/A2UI/development/docs/package_releases.md) | ||
| - **Python Publishing Technical Guide**: [agent_sdks/python/docs/python_publishing.md](file:///Users/jsimionato/development/a2ui_repos/release-oncall/A2UI/agent_sdks/python/docs/python_publishing.md) |
There was a problem hiding this comment.
These links use absolute local file URLs (file:///Users/jsimionato/...) which will be broken for other users and leak local environment paths. They should be converted to relative paths.
| - **General Release Guide**: [development/docs/package_releases.md](file:///Users/jsimionato/development/a2ui_repos/release-oncall/A2UI/development/docs/package_releases.md) | |
| - **Python Publishing Technical Guide**: [agent_sdks/python/docs/python_publishing.md](file:///Users/jsimionato/development/a2ui_repos/release-oncall/A2UI/agent_sdks/python/docs/python_publishing.md) | |
| - **General Release Guide**: [development/docs/package_releases.md](../../development/docs/package_releases.md) | |
| - **Python Publishing Technical Guide**: [agent_sdks/python/docs/python_publishing.md](docs/python_publishing.md) |
|
|
||
| This guide details the technical publishing process for Python SDK packages in `agent_sdks/python/` (`a2ui-agent-sdk` and `a2ui-core`). | ||
|
|
||
| For generic release principles, authentication prerequisites, and changelog rules, see [development/docs/package_releases.md](file:///Users/jsimionato/development/a2ui_repos/release-oncall/A2UI/development/docs/package_releases.md). |
There was a problem hiding this comment.
This link uses an absolute local file URL (file:///Users/jsimionato/...) which will be broken for other users and leak local environment paths. It should be converted to a relative path.
| For generic release principles, authentication prerequisites, and changelog rules, see [development/docs/package_releases.md](file:///Users/jsimionato/development/a2ui_repos/release-oncall/A2UI/development/docs/package_releases.md). | |
| For generic release principles, authentication prerequisites, and changelog rules, see [development/docs/package_releases.md](../../../development/docs/package_releases.md). |
| - **Python SDKs**: [agent_sdks/python/docs/python_publishing.md](file:///Users/jsimionato/development/a2ui_repos/release-oncall/A2UI/agent_sdks/python/docs/python_publishing.md) | ||
| - **TypeScript/Web Packages**: [renderers/docs/web_publishing.md](file:///Users/jsimionato/development/a2ui_repos/release-oncall/A2UI/renderers/docs/web_publishing.md) |
There was a problem hiding this comment.
These links use absolute local file URLs (file:///Users/jsimionato/...) which will be broken for other users and leak local environment paths. They should be converted to relative paths.
| - **Python SDKs**: [agent_sdks/python/docs/python_publishing.md](file:///Users/jsimionato/development/a2ui_repos/release-oncall/A2UI/agent_sdks/python/docs/python_publishing.md) | |
| - **TypeScript/Web Packages**: [renderers/docs/web_publishing.md](file:///Users/jsimionato/development/a2ui_repos/release-oncall/A2UI/renderers/docs/web_publishing.md) | |
| - **Python SDKs**: [agent_sdks/python/docs/python_publishing.md](../../agent_sdks/python/docs/python_publishing.md) | |
| - **TypeScript/Web Packages**: [renderers/docs/web_publishing.md](../../renderers/docs/web_publishing.md) |
| ``` | ||
| 2. **Create GitHub Release**: | ||
| ```bash | ||
| gh release create vX.Y.Z --title "vX.Y.Z" --notes-file CHANGELOG.md |
There was a problem hiding this comment.
There is no global CHANGELOG.md at the root of the repository; each package maintains its own CHANGELOG.md in its package root directory. Therefore, --notes-file CHANGELOG.md should be updated to --notes-file <path_to_package_CHANGELOG.md> to match the convention used in other parts of the documentation.
| gh release create vX.Y.Z --title "vX.Y.Z" --notes-file CHANGELOG.md | |
| gh release create vX.Y.Z --title "vX.Y.Z" --notes-file <path_to_package_CHANGELOG.md> |
Automated version bump and changelog preparation for a2ui-agent-sdk v0.3.1 and a2ui-core v0.1.1.