Skip to content

Commit

Permalink
Merge pull request #144 from vintasoftware/release/0.0.2
Browse files Browse the repository at this point in the history
Release 0.0.2
  • Loading branch information
pamella authored Jun 28, 2024
2 parents dac9fbf + 0da6bf1 commit 2e61c29
Show file tree
Hide file tree
Showing 6 changed files with 16 additions and 9 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +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.2 <small>June 28, 2024</small> {id="0.0.2"}

- Add support for Django 4.2 LTS
- Add support for Python 3.10 and 3.11

## 0.0.1 <small>June 25, 2024</small> {id="0.0.1"}

- Initial release
12 changes: 7 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
2 changes: 1 addition & 1 deletion frontend/openapi_schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"openapi": "3.1.0",
"info": {
"title": "django_ai_assistant",
"version": "0.0.1",
"version": "0.0.2",
"description": ""
},
"paths": {
Expand Down
2 changes: 1 addition & 1 deletion frontend/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
2 changes: 1 addition & 1 deletion frontend/src/client/core/OpenAPI.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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(),
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -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 <[email protected]>"]
license = "MIT"
Expand Down

0 comments on commit 2e61c29

Please sign in to comment.