Set Versions and Update Readme (#142)

* preparing version files for ahnlich launch

* rust and python clients now deploy to crates.io and pypi

* change rust toolchain in workflow

* final preparations for launch

Author: Iamdavidonuh

.github/workflows/python_tag_and_deploy.yml

@@ -81,9 +81,8 @@ jobs:
         working-directory: ./sdk/ahnlich-client-py
         run: |
           echo "Deploying tag ${{needs.check_version_changes_and_tag.outputs.client_version}}"
-          poetry config repositories.test-pypi https://test.pypi.org/legacy/
           poetry run change_poetry_version
-          poetry config pypi-token.test-pypi  ${{ secrets.TEST_PYPI_TOKEN }}
-          poetry build && poetry publish -r test-pypi
+          poetry config pypi-token.pypi ${{ secrets.PYPI_TOKEN }}
+          poetry publish --build
 
 

.github/workflows/release.yml

@@ -33,7 +33,7 @@ jobs:
             - name: Get Cargo toolchain
               uses: actions-rs/toolchain@v1
               with:
-                toolchain: 1.78.0
+                toolchain: 1.81.0
 
             - name: Setup Zig
               uses: mlugg/setup-zig@v1

.github/workflows/rust_tag_and_deploy.yml

@@ -66,10 +66,10 @@ jobs:
       - name: Get Cargo toolchain
         uses: actions-rs/toolchain@v1
         with:
-          toolchain: 1.78.0
+          toolchain: 1.81.0
 
       - name: Deploy using tag
         working-directory: ./ahnlich
         run: |
-          cargo publish -p ahnlich_types --dry-run --token '${{secrets.CARGO_TOKEN}}'
-          cargo publish -p ahnlich_client_rs --dry-run --token '${{secrets.CARGO_TOKEN}}'
+          cargo publish -p ahnlich_types --token '${{secrets.CARGO_TOKEN}}'
+          cargo publish -p ahnlich_client_rs --token '${{secrets.CARGO_TOKEN}}'

README.md

@@ -62,11 +62,58 @@ The DB can be used without the AI proxy for more fine grained control of the gen
 
 View [contribution guide](CONTRIBUTING.md)
 
-### How Client Releases Work
+### Version Format
 
-The clients follow a similar process when deploying new releases.
-[Example with python client](https://github.com/deven96/ahnlich/blob/main/sdk/ahnlich-client-py/README.md#deploy-to-artifactory).
+`<TYPE>/<NAME>/<VERSION_NUMBER>`
 
+Where:
+- TYPE: Bin, Client,
+- NAME: AI, DB, PY, RS
+- VERSION_NUMBER: Semver
+
+
+### How Deployments and Releases Work
+
+Ahnlich maintains two separate versioning systems: **Protocol Versions** and **Client Versions**. Understanding how these interact is key to managing releases across binaries, libraries, and Docker images.
+
+#### Protocol and Client Versioning
+- The **Protocol Version** represents changes to the underlying communication standard between different Ahnlich components. Major bump to this version can introduce breaking changes, meaning requests made by outdated clients will be rejected.
+- The **Client Version** tracks updates to the client libraries. These are versioned separately but are often synchronized with protocol updates to ensure compatibility.
+
+##### Bumping Protocol Versions
+- To bump both the Protocol and Client versions simultaneously, use the following command:
+  ```bash
+  make bump-protocol-version BUMP_RULE=[major, minor, patch]
+  ```
+  This will trigger deployments for all relevant binaries (like AI, CLI, and DB) as well as client libraries.
+- Major changes to the Protocol Version may involve breaking changes, so ahnlich AI or DB rejects a connection when the major version don't match.
+
+##### Bumping Individual Package/Crate Versions
+- The Makefile contains additional commands for selectively bumping versions of crate or lib within the workspace. 
+
+#### Releasing New Binaries (AI, CLI, DB), Images and Client Libs
+When deploying new binaries, the updated versions are pushed to their respective Artifactory repositories. The workflow is as follows:
+
+##### Binaries and Docker Images
+1. **Bump the Protocol Version**: Use the appropriate Makefile commands to bump versions for AI, CLI, or DB binaries or client Libs.
+
+2. Submit a PR to main
+3. Once merged, Create a tag using the the ahnlich tag format
+4. Create a Release from tag which triggers building of binaries and docker images
+
+##### Client Libraries (Example Python)
+
+- Update the `MSG_TAG` file with a new tag message.
+- From a feature branch, bump the version using:
+  ```bash
+  make bump-py-client BUMP_RULE=[major, minor, patch]
+  ```
+  or
+  ```bash
+  poetry run bumpversion [major, minor, patch]
+  ```
+- Open a PR to Main
+- Once merged, this automatically creates a tags if a change to the version file is detected and deploys the lib to it's artifactory.
 
 
 

ahnlich/Cargo.lock

@@ -67,6 +67,10 @@ bump-protocol-version: ## Bump project versions. Rules for bumpversion: patch, m
 	@cd $(RUST_PROJECT_DIR) && cargo set-version --bump $(BUMP_RULE) --package $(AHNLICH_AI_NAME)
 	@echo "Ahnlich AI version bumped to $(BUMP_RULE)"
 
+	@echo "Bumping Rust client version with rule $(BUMP_RULE)"
+	@cd $(RUST_PROJECT_DIR) && cargo set-version --bump $(BUMP_RULE) --package $(RUST_CLIENT_NAME)
+	@echo "Rust client version bumped to $(BUMP_RULE)"
+
 	@echo "Bumping Python project version with rule $(BUMP_RULE)"
 	@cd $(PYTHON_PROJECT_DIR) && poetry run bumpversion --component Protocol --bump-type $(BUMP_RULE)
 	@echo "Python project version bumped using rule $(BUMP_RULE)"

ahnlich/Makefile

@@ -1,6 +1,6 @@
 [package]
 name = "ai"
-version = "0.1.0"
+version = "0.0.0"
 edition = "2021"
 
 # only used for rust client test and not to be released

ahnlich/ai/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "cli"
-version = "0.1.0"
+version = "0.0.0"
 edition = "2021"
 
 [[bin]]

ahnlich/cli/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "ahnlich_client_rs"
-version = "0.1.0"
+version = "0.0.0"
 authors = ["Diretnan Domnan <[email protected]>"]
 categories = ["database-implementations", "database", "web-programming"]
 keywords = ["ahnlich", "in-memory", "artificial-intelligence", "ai"]

ahnlich/client/Cargo.toml

@@ -24,6 +24,6 @@ cargo add ahnlich_client_rs
 
 | Version| Description           |
 | -------|:-------------:|
-| 0.1.0 | Base Rust client to connect to ahnlich db. Bincode serialization and deserialization implemented |
+| 0.0.0 | Base Rust client to connect to ahnlich db. Bincode serialization and deserialization implemented |