diff --git a/CHANGELOG.md b/CHANGELOG.md index e781bc4..5a2afdd 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,6 +8,10 @@ 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.3 July 5, 2024 {id="0.0.3"} + +- Less restrictive Python version in pyproject.toml. Support future Python versions. + ## 0.0.2 June 28, 2024 {id="0.0.2"} - Add support for Django 4.2 LTS diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3b55dcc..70cf2fd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -102,10 +102,17 @@ 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. 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. +2. Re-install the local version of the Python project: `poetry install` +3. In the project root, run `poetry run python manage.py generate_openapi_schema --output frontend/openapi_schema.json` to update the OpenAPI schema. +4. Re-install the local version of the frontend project: +```bash +cd frontend +pnpm install +pnpm run build +``` +5. In the frontend directory, run `pnpm run generate-client` to update the TypeScript client with the new OpenAPI schema. +6. Update the changelog in `CHANGELOG.md`. +7. Open a PR with the changes. +8. 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. +9. Review the draft release, ensure the description has at least the associated changelog entry, and publish it. +10. 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 ee16121..3280c93 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.2", + "version": "0.0.3", "description": "" }, "paths": { diff --git a/frontend/package.json b/frontend/package.json index 6e477ad..3c5760f 100644 --- a/frontend/package.json +++ b/frontend/package.json @@ -20,7 +20,7 @@ "engines": { "node": ">=20 <21" }, - "version": "0.0.2", + "version": "0.0.3", "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", @@ -85,4 +85,4 @@ "vite": "^5.3.2", "vite-plugin-dts": "^3.9.1" } -} +} \ No newline at end of file diff --git a/frontend/src/client/core/OpenAPI.ts b/frontend/src/client/core/OpenAPI.ts index 58c5fa3..d1704eb 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.2', + VERSION: '0.0.3', WITH_CREDENTIALS: false, interceptors: { request: new Interceptors(), diff --git a/pyproject.toml b/pyproject.toml index 54fa600..41a36d8 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "django-ai-assistant" -version = "0.0.2" +version = "0.0.3" description = "Django app to integrate with OpenAI Assistants API" authors = ["Vinta Software "] license = "MIT"