ragstack: add release instructions

datastax · May 7, 2024 · 43e1607 · 43e1607
1 parent f910b6b
commit 43e1607
Showing 1 changed file with 21 additions and 0 deletions.
diff --git a/ragstack/RELEASE.md b/ragstack/RELEASE.md
@@ -0,0 +1,21 @@
+# Release RAGStack Langflow packages
+
+The main package `ragstack-ai-langflow` depends on `ragstack-ai-langflow-base` and the version is pinned.
+This implies that every release of `ragstack-ai-langflow-base` will also need a release of `ragstack-ai-langflow`.
+
+## Release `ragstack-ai-langflow-base`
+
+- Run the release script:
+  ```shell
+  ./ragstack/ragstack-release.sh 0.0.2 ragstack-ai-langflow-base
+  ```
+  The script will take care of updating the version in `ragstack-ai-langflow-base` and pushing the changes to the repository. CI will automatically release the package on PyPI.
+
+## Release `ragstack-ai-langflow`
+
+- Update the `pyproject.toml` file pointing to the correct version of `ragstack-ai-langflow-base`. Run `poetry lock` and open a PR to trigger the tests. Once merged, proceed with the next steps.
+- Run the release script:
+  ```shell
+  ./ragstack/ragstack-release.sh 0.0.2 ragstack-ai-langflow
+  ```
+  The script will take care of updating the version in `ragstack-ai-langflow` and pushing the changes to the repository. CI will automatically release the package on PyPI.