chore: add script to automate python tagging (#598)

Author: 0xRAG

.github/workflows/version_publish_npm.yml

@@ -32,8 +32,8 @@ jobs:
       - name: Version and/or Publish to NPM
         uses: changesets/action@06245a4e0a36c064a573d4150030f5ec548e4fcc
         with:
-          commit: "chore: version packages"
-          title: "chore: version packages"
+          commit: "chore: version typescript packages"
+          title: "chore: version typescript packages"
           version: npm run changeset:version
           publish: npm run publish
           cwd: ./typescript

.gitignore

@@ -133,3 +133,5 @@ api.json
 docs/
 !python/coinbase-agentkit/docs/
 !python/framework-extensions/langchain/docs/
+
+.to-publish-pypi

CONTRIBUTING-PYTHON.md

@@ -12,6 +12,7 @@ This guide covers Python-specific setup and development for AgentKit.
 - [Code Style](#code-style)
 - [Documentation](#documentation)
 - [Changelog](#changelog)
+- [Releasing](#releasing)
 
 ## Development Setup
 
@@ -264,3 +265,18 @@ The types of changes you can add are:
 
 - `feature`
 - `bugfix`
+
+## Releasing
+
+When ready to release the Python packages, follow these steps.
+
+1. From the `python/` folder, run: `./scripts/version.sh`
+   - This creates a file `.to-publish-pypi` containing which packages have changes, and the new version that will be published. This file is automatically used in step 5.
+2. Commit the changes and open a PR with message: `chore: version python packages`
+3. Get PR reviewed and merge to `main`
+4. Run GitHub Actions to release changed packages
+   - [Publish AgentKit Core Action](https://github.com/coinbase/agentkit/actions/workflows/publish_pypi_coinbase_agentkit.yml)
+   - [Publish Create Onchain Agent Action](https://github.com/coinbase/agentkit/actions/workflows/publish_pypi_create_onchain_agent.yml)
+   - [Publish Agentkit Langchain Action](https://github.com/coinbase/agentkit/actions/workflows/publish_pypi_coinbase_agentkit_langchain.yml)
+   - [Publish Open AI Extension](https://github.com/coinbase/agentkit/actions/workflows/publish_pypi_coinbase_agentkit_openai_agents_sdk.yml)
+5. After all changed packages have been published, rebase `main` and, from the `python/` folder, run the following command to automatically create and push tags for changed packages: `./scripts/tag.sh`

CONTRIBUTING-TYPESCRIPT.md

@@ -12,6 +12,7 @@ This guide covers TypeScript-specific setup and development for AgentKit.
 - [Code Style](#code-style)
 - [Documentation](#documentation)
 - [Changelog](#changelog)
+- [Releasing](#releasing)
 
 ## Development Setup
 
@@ -284,3 +285,7 @@ This will kick off an interactive prompt to help you create the changeset. Use t
 Once complete, a new changeset will be created in the `.changeset` directory, which should be committed along with the changes in your Pull Request.
 
 For more info on adding changelog entries, [see here](https://github.com/changesets/changesets/blob/main/docs/adding-a-changeset.md).
+
+## Releasing
+
+When ready to release the TypeScript packages, just review & merge the changesets PR (look for a PR titled "chore: version typescript packages"). This will automatically kick off the publish in the [changesets action](https://github.com/coinbase/agentkit/tree/main/.github/workflows/version_publish_npm.yml).

CONTRIBUTING.md

@@ -2,6 +2,15 @@
 
 Thank you for your interest in contributing to AgentKit! We welcome all contributions, no matter how big or small.
 
+## Contents
+
+- [Repository Structure](#repository-structure)
+- [Language-Specific Guides](#language-specific-guides)
+- [Contributing Workflow](#contributing-workflow)
+- [Releasing](#releasing)
+- [Getting Help](#getting-help)
+- [Monorepo Development Tips](#monorepo-development-tips)
+
 ## Repository Structure
 
 The AgentKit repository is organized as two [monorepos](https://vercel.com/docs/vercel-platform/glossary#monorepo), one for Python and one for TypeScript. The TypeScript side is organized as a [multi-package workspace](https://vercel.com/docs/vercel-platform/glossary#multi-package-workspace) and is managed with [Turborepo](https://turbo.build/repo/docs), while the Python side is simply a collection of Python packages. A Python package is a single subfolder with a `pyproject.toml` file, along with related code and files that are published together to PyPI, whereas a TypeScript [package](https://vercel.com/docs/vercel-platform/glossary#package) is a single subfolder with a `package.json` and related code that is published to NPM. For example, the `typescript/agentkit` subfolder is a TypeScript package, and the `python/coinbase-agentkit` subfolder is a Python package.
@@ -91,6 +100,11 @@ Current list of maintainers:
 - [@0xRAG](https://github.com/0xRAG)
 - [@yuga-cb](https://github.com/yuga-cb)
 
+## Releasing
+
+- For TypeScript, see [TypeScript Development Guide](./CONTRIBUTING-TYPESCRIPT.md#releasing)
+- For Python, see [Python Development Guide](./CONTRIBUTING-PYTHON.md#releasing)
+
 ## Getting Help
 
 If you're stuck, there are a few ways to get help:

python/README.md

@@ -33,4 +33,4 @@ See [Create Onchain Agent](./create-onchain-agent/README.md) to get started!
 **AgentKit is actively looking for community contributions!**
 
 - To see a list of actions and frameworks we'd love to see open-source contributions for, see [WISHLIST.md](../WISHLIST.md).
-- To understand the process for contributing to AgentKit, see [CONTRIBUTING.md](../CONTRIBUTING.md).
+- To understand the process for contributing to AgentKit, see [CONTRIBUTING.md](../CONTRIBUTING.md).

python/scripts/tag.sh

@@ -0,0 +1,18 @@
+while IFS= read -r package; do
+  name=$(echo "$package" | cut -d ' ' -f 1)
+  version=$(echo "$package" | cut -d ' ' -f 2)
+  
+  if [ "$name" = "create-onchain-agent" ]; then
+    tag_name="create-onchain-agent-python"
+    message="Release create-onchain-agent python version $version"
+  else
+    tag_name="$name"
+    message="Release $name version $version"
+  fi
+
+  echo "git tag -a \"$tag_name@$version\" -m \"$message\""
+  git tag -a "$tag_name@$version" -m "$message"
+
+  echo "git push origin \"$tag_name@$version\""
+  git push origin "$tag_name@$version"
+done < .to-publish-pypi

python/scripts/version.sh

@@ -20,9 +20,16 @@ for package in "${all_packages[@]}"; do
   fi
 done
 
+rm -f .to-publish-pypi
+touch .to-publish-pypi
+
+ROOT_DIR=$(pwd)
+
 for package in "${changed_packages[@]}"; do
   cd $package
   poetry install
   poetry run -- towncrier build --yes
+  package_and_version=$(poetry version)
+  echo "$package_and_version" >> "${ROOT_DIR}/.to-publish-pypi"
   cd - > /dev/null
 done