From 7ab46e69e58b88c3709b44e71edaf3243ec3e8d2 Mon Sep 17 00:00:00 2001 From: Pamella Bezerra Date: Fri, 28 Jun 2024 16:17:47 -0300 Subject: [PATCH 1/2] Release 0.0.2 --- CHANGELOG.md | 6 ++++++ CONTRIBUTING.md | 12 +++++++----- frontend/openapi_schema.json | 2 +- frontend/package.json | 2 +- frontend/src/client/core/OpenAPI.ts | 2 +- pyproject.toml | 2 +- 6 files changed, 17 insertions(+), 9 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 01a9117..4f8034d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -11,3 +11,9 @@ frontend TypeScript client, `django-ai-assistant-client`. ## 0.0.1 June 25, 2024 {id="0.0.1"} - Initial release + +## 0.0.2 June 28, 2024 {id="0.0.2"} + +- Add support for Django 4.2 LTS +- Add support for Python 3.10 and 3.11 + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index afba98b..3b55dcc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -102,8 +102,10 @@ poetry run mkdocs serve To release and publish a new version, follow these steps: 1. Update the version in `pyproject.toml` and `frontend/package.json`. -2. Update the changelog in `CHANGELOG.md`. -3. Open a PR with the changes. -4. Once the PR is merged, run the [Release GitHub Action](https://github.com/vintasoftware/django-ai-assistant/actions/workflows/release.yml) to create a draft release. -5. Review the draft release, ensure the description has at least the associated changelog entry, and publish it. -6. Once the review is publish, the [Publish GitHub Action](https://github.com/vintasoftware/django-ai-assistant/actions/workflows/publish.yml) will automatically run to publish the new version to [PyPI](https://pypi.org/project/django-ai-assistant) and [npm](https://www.npmjs.com/package/django-ai-assistant-client). Check the logs to ensure the publication was successful. +2. In the project root, run `poetry run python manage.py generate_openapi_schema --output frontend/openapi_schema.json` to update the OpenAPI schema. +3. In the frontend directory, run `pnpm run generate-client` to update the TypeScript client with the new OpenAPI schema. +4. Update the changelog in `CHANGELOG.md`. +5. Open a PR with the changes. +6. Once the PR is merged, run the [Release GitHub Action](https://github.com/vintasoftware/django-ai-assistant/actions/workflows/release.yml) to create a draft release. +7. Review the draft release, ensure the description has at least the associated changelog entry, and publish it. +8. Once the review is publish, the [Publish GitHub Action](https://github.com/vintasoftware/django-ai-assistant/actions/workflows/publish.yml) will automatically run to publish the new version to [PyPI](https://pypi.org/project/django-ai-assistant) and [npm](https://www.npmjs.com/package/django-ai-assistant-client). Check the logs to ensure the publication was successful. diff --git a/frontend/openapi_schema.json b/frontend/openapi_schema.json index efe0471..ee16121 100644 --- a/frontend/openapi_schema.json +++ b/frontend/openapi_schema.json @@ -2,7 +2,7 @@ "openapi": "3.1.0", "info": { "title": "django_ai_assistant", - "version": "0.0.1", + "version": "0.0.2", "description": "" }, "paths": { diff --git a/frontend/package.json b/frontend/package.json index 41465fe..6e477ad 100644 --- a/frontend/package.json +++ b/frontend/package.json @@ -20,7 +20,7 @@ "engines": { "node": ">=20 <21" }, - "version": "0.0.1", + "version": "0.0.2", "description": "TypeScript client to facilitate the integration with the Django AI Assistant backend.", "homepage": "https://github.com/vintasoftware/django-ai-assistant", "documentation": "https://vintasoftware.github.io/django-ai-assistant", diff --git a/frontend/src/client/core/OpenAPI.ts b/frontend/src/client/core/OpenAPI.ts index 8e48f3c..58c5fa3 100644 --- a/frontend/src/client/core/OpenAPI.ts +++ b/frontend/src/client/core/OpenAPI.ts @@ -48,7 +48,7 @@ export const OpenAPI: OpenAPIConfig = { PASSWORD: undefined, TOKEN: undefined, USERNAME: undefined, - VERSION: '0.0.1', + VERSION: '0.0.2', WITH_CREDENTIALS: false, interceptors: { request: new Interceptors(), diff --git a/pyproject.toml b/pyproject.toml index 995721c..08e93f5 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "django-ai-assistant" -version = "0.0.1" +version = "0.0.2" description = "Django app to integrate with OpenAI Assistants API" authors = ["Vinta Software "] license = "MIT" From 7065691a6322b111a684c6e2543a6b545890a855 Mon Sep 17 00:00:00 2001 From: Pamella Bezerra Date: Fri, 28 Jun 2024 16:24:55 -0300 Subject: [PATCH 2/2] Fix the order --- CHANGELOG.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4f8034d..e781bc4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,12 +8,11 @@ frontend TypeScript client, `django-ai-assistant-client`. The backend and the frontend are versioned together, that is, they have the same version number. When you update the backend, you should also update the frontend to the same version. -## 0.0.1 June 25, 2024 {id="0.0.1"} - -- Initial release - ## 0.0.2 June 28, 2024 {id="0.0.2"} - Add support for Django 4.2 LTS - Add support for Python 3.10 and 3.11 +## 0.0.1 June 25, 2024 {id="0.0.1"} + +- Initial release