Skip to content

Commit f159886

Browse files
authored
Merge pull request #149 from vintasoftware/release/0.0.3
Release/0.0.3
2 parents 34dbedb + b13cda2 commit f159886

File tree

6 files changed

+23
-12
lines changed

6 files changed

+23
-12
lines changed

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@ frontend TypeScript client, `django-ai-assistant-client`.
88
The backend and the frontend are versioned together, that is, they have the same version number.
99
When you update the backend, you should also update the frontend to the same version.
1010

11+
## 0.0.3 <small>July 5, 2024</small> {id="0.0.3"}
12+
13+
- Less restrictive Python version in pyproject.toml. Support future Python versions.
14+
1115
## 0.0.2 <small>June 28, 2024</small> {id="0.0.2"}
1216

1317
- Add support for Django 4.2 LTS

CONTRIBUTING.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -102,10 +102,17 @@ poetry run mkdocs serve
102102
To release and publish a new version, follow these steps:
103103

104104
1. Update the version in `pyproject.toml` and `frontend/package.json`.
105-
2. In the project root, run `poetry run python manage.py generate_openapi_schema --output frontend/openapi_schema.json` to update the OpenAPI schema.
106-
3. In the frontend directory, run `pnpm run generate-client` to update the TypeScript client with the new OpenAPI schema.
107-
4. Update the changelog in `CHANGELOG.md`.
108-
5. Open a PR with the changes.
109-
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.
110-
7. Review the draft release, ensure the description has at least the associated changelog entry, and publish it.
111-
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.
105+
2. Re-install the local version of the Python project: `poetry install`
106+
3. In the project root, run `poetry run python manage.py generate_openapi_schema --output frontend/openapi_schema.json` to update the OpenAPI schema.
107+
4. Re-install the local version of the frontend project:
108+
```bash
109+
cd frontend
110+
pnpm install
111+
pnpm run build
112+
```
113+
5. In the frontend directory, run `pnpm run generate-client` to update the TypeScript client with the new OpenAPI schema.
114+
6. Update the changelog in `CHANGELOG.md`.
115+
7. Open a PR with the changes.
116+
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.
117+
9. Review the draft release, ensure the description has at least the associated changelog entry, and publish it.
118+
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.

frontend/openapi_schema.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"openapi": "3.1.0",
33
"info": {
44
"title": "django_ai_assistant",
5-
"version": "0.0.2",
5+
"version": "0.0.3",
66
"description": ""
77
},
88
"paths": {

frontend/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
"engines": {
2121
"node": ">=20 <21"
2222
},
23-
"version": "0.0.2",
23+
"version": "0.0.3",
2424
"description": "TypeScript client to facilitate the integration with the Django AI Assistant backend.",
2525
"homepage": "https://github.com/vintasoftware/django-ai-assistant",
2626
"documentation": "https://vintasoftware.github.io/django-ai-assistant",
@@ -85,4 +85,4 @@
8585
"vite": "^5.3.2",
8686
"vite-plugin-dts": "^3.9.1"
8787
}
88-
}
88+
}

frontend/src/client/core/OpenAPI.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ export const OpenAPI: OpenAPIConfig = {
4848
PASSWORD: undefined,
4949
TOKEN: undefined,
5050
USERNAME: undefined,
51-
VERSION: '0.0.2',
51+
VERSION: '0.0.3',
5252
WITH_CREDENTIALS: false,
5353
interceptors: {
5454
request: new Interceptors(),

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[tool.poetry]
22
name = "django-ai-assistant"
3-
version = "0.0.2"
3+
version = "0.0.3"
44
description = "Django app to integrate with OpenAI Assistants API"
55
authors = ["Vinta Software <contact@vinta.com.br>"]
66
license = "MIT"

0 commit comments

Comments
 (0)