You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+14-7Lines changed: 14 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -102,10 +102,17 @@ poetry run mkdocs serve
102
102
To release and publish a new version, follow these steps:
103
103
104
104
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.
0 commit comments