diff --git a/Development.md b/Development.md index cfe21f6b..23b025de 100644 --- a/Development.md +++ b/Development.md @@ -346,3 +346,70 @@ For Swift code in the `libs/lume` directory: - Follow the [Swift API Design Guidelines](https://www.swift.org/documentation/api-design-guidelines/) - Use SwiftFormat for consistent formatting - Code will be automatically formatted on save when using the lume workspace + +## Releasing Packages + +Cua uses `bump2version` to manage package versions across all Python modules. A Makefile is provided to simplify the release process. + +### Prerequisites + +#### install `bump2version` + +using brew + +``` +brew install bumpversion +``` + +### View Current Versions + +```bash +make show-versions +``` + +### Bump Package Versions + +To bump a specific package version: + +```bash +# Patch version bump (e.g., 0.1.8 → 0.1.9) +make bump-patch-core # cua-core +make bump-patch-pylume # pylume +make bump-patch-computer # cua-computer +make bump-patch-som # cua-som +make bump-patch-agent # cua-agent +make bump-patch-computer-server # cua-computer-server +make bump-patch-mcp-server # cua-mcp-server + +# Minor version bump (e.g., 0.1.8 → 0.2.0) +make bump-minor-core # Replace 'core' with any package name + +# Major version bump (e.g., 0.1.8 → 1.0.0) +make bump-major-core # Replace 'core' with any package name +``` + +### Dry Run (Test Before Bumping) + +To preview changes without modifying files: + +```bash +make dry-run-patch-core # Test patch bump for cua-core +make dry-run-minor-pylume # Test minor bump for pylume +make dry-run-major-agent # Test major bump for cua-agent +``` + +### Bump All Packages (Use with Caution) + +```bash +make bump-all-patch # Bumps patch version for ALL packages +``` + +### After Bumping + +After running any bump command, push your changes: + +```bash +git push origin main && git push origin --tags +``` + +For more details, run `make help` or see the [Makefile](./Makefile). diff --git a/README.md b/README.md index 1d09535c..f47549fa 100644 --- a/README.md +++ b/README.md @@ -14,13 +14,6 @@ -> We're hosting **The Computer-Use Agents SOTA Challenge concluded** at [Hack the North](https://hackthenorth.com) and online! -> -> > **Track A (On-site @ UWaterloo)**: 🏆 ~~Prize: **YC interview guaranteed**.~~ **Concluded** -> > **Track B (Remote)**: 🏆 ~~Prize: **Cash award**.~~ **Concluded - Winners will be announced soon** -> > -> > > ~~👉 Sign up here: [trycua.com/hackathon](https://www.trycua.com/hackathon)~~ - **Cua** ("koo-ah") is Docker for [Computer-Use Agents](https://www.oneusefulthing.org/p/when-you-give-a-claude-a-mouse) - it enables AI agents to control full operating systems in virtual containers and deploy them locally or to the cloud.
@@ -216,73 +209,6 @@ Some optional extras for this project depend on third-party packages that are li When you choose to install and use such optional extras, your use, modification, and distribution of those third-party components are governed by their respective licenses (e.g., AGPL-3.0 for `ultralytics`). -## Releasing Packages - -Cua uses `bump2version` to manage package versions across all Python modules. A Makefile is provided to simplify the release process. - -### Prerequisites - -#### install `bump2version` - -using brew - -``` -brew install bumpversion -``` - -### View Current Versions - -```bash -make show-versions -``` - -### Bump Package Versions - -To bump a specific package version: - -```bash -# Patch version bump (e.g., 0.1.8 → 0.1.9) -make bump-patch-core # cua-core -make bump-patch-pylume # pylume -make bump-patch-computer # cua-computer -make bump-patch-som # cua-som -make bump-patch-agent # cua-agent -make bump-patch-computer-server # cua-computer-server -make bump-patch-mcp-server # cua-mcp-server - -# Minor version bump (e.g., 0.1.8 → 0.2.0) -make bump-minor-core # Replace 'core' with any package name - -# Major version bump (e.g., 0.1.8 → 1.0.0) -make bump-major-core # Replace 'core' with any package name -``` - -### Dry Run (Test Before Bumping) - -To preview changes without modifying files: - -```bash -make dry-run-patch-core # Test patch bump for cua-core -make dry-run-minor-pylume # Test minor bump for pylume -make dry-run-major-agent # Test major bump for cua-agent -``` - -### Bump All Packages (Use with Caution) - -```bash -make bump-all-patch # Bumps patch version for ALL packages -``` - -### After Bumping - -After running any bump command, push your changes: - -```bash -git push origin main && git push origin --tags -``` - -For more details, run `make help` or see the [Makefile](./Makefile). - ## Contributing We welcome contributions to Cua! Please refer to our [Contributing Guidelines](CONTRIBUTING.md) for details.