From 4096b2ab046d855babf0644e9c7e394aa4069e0a Mon Sep 17 00:00:00 2001 From: GitHub Date: Sat, 8 Jun 2024 21:20:46 +0000 Subject: [PATCH] chore: prepare release 0.21.0 --- ...added_an_output_path_option_to_generate.md | 9 ------ .../added_an_overwrite_flag_to_generate.md | 8 ----- .changeset/remove_the_update_command.md | 18 ----------- CHANGELOG.md | 32 +++++++++++++++++++ pyproject.toml | 2 +- 5 files changed, 33 insertions(+), 36 deletions(-) delete mode 100644 .changeset/added_an_output_path_option_to_generate.md delete mode 100644 .changeset/added_an_overwrite_flag_to_generate.md delete mode 100644 .changeset/remove_the_update_command.md diff --git a/.changeset/added_an_output_path_option_to_generate.md b/.changeset/added_an_output_path_option_to_generate.md deleted file mode 100644 index 864352375..000000000 --- a/.changeset/added_an_output_path_option_to_generate.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -default: minor ---- - -# Added an `--output-path` option to `generate` - -Rather than changing directories before running `generate` you can now specify an output directory with `--output-path`. -Note that the project name will _not_ be appended to the `--output-path`, whatever path you specify is where the -generated code will be placed. diff --git a/.changeset/added_an_overwrite_flag_to_generate.md b/.changeset/added_an_overwrite_flag_to_generate.md deleted file mode 100644 index 9c38bb2e8..000000000 --- a/.changeset/added_an_overwrite_flag_to_generate.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -default: minor ---- - -# Added an `--overwrite` flag to `generate` - -You can now tell `openapi-python-client` to overwrite an existing directory, rather than deleting it yourself before -running `generate`. diff --git a/.changeset/remove_the_update_command.md b/.changeset/remove_the_update_command.md deleted file mode 100644 index 51a790af1..000000000 --- a/.changeset/remove_the_update_command.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -default: major ---- - -# Removed the `update` command - -The `update` command is no more, you can (mostly) replace its usage with some new flags on the `generate` command. - -If you had a package named `my-api-client` in the current working directory, the `update` command previously would update the `my_api_client` module within it. You can now _almost_ perfectly replicate this behavior using `openapi-python-client generate --meta=none --output-path=my-api-client/my_api_client --overwrite`. - -The only difference is that `my-api-client` would have run `post_hooks` in the `my-api-client` directory, -but `generate` will run `post_hooks` in the `output-path` directory. - -Alternatively, you can now also run `openapi-python-client generate --meta= --overwrite` to regenerate -the entire client, if you don't care about keeping any changes you've made to the generated client. - -Please comment on [discussion #824](https://github.com/openapi-generators/openapi-python-client/discussions/824) -(or a new discussion, as appropriate) to aid in designing future features that fill any gaps this leaves for you. diff --git a/CHANGELOG.md b/CHANGELOG.md index e14f086cb..83bcce466 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -13,6 +13,38 @@ Programmatic usage of this project (e.g., importing it as a Python module) and t The 0.x prefix used in versions for this project is to indicate that breaking changes are expected frequently (several times a year). Breaking changes will increment the minor number, all other changes will increment the patch number. You can track the progress toward 1.0 [here](https://github.com/openapi-generators/openapi-python-client/projects/2). +## 0.21.0 (2024-06-08) + +### Breaking Changes + +#### Removed the `update` command + +The `update` command is no more, you can (mostly) replace its usage with some new flags on the `generate` command. + +If you had a package named `my-api-client` in the current working directory, the `update` command previously would update the `my_api_client` module within it. You can now _almost_ perfectly replicate this behavior using `openapi-python-client generate --meta=none --output-path=my-api-client/my_api_client --overwrite`. + +The only difference is that `my-api-client` would have run `post_hooks` in the `my-api-client` directory, +but `generate` will run `post_hooks` in the `output-path` directory. + +Alternatively, you can now also run `openapi-python-client generate --meta= --overwrite` to regenerate +the entire client, if you don't care about keeping any changes you've made to the generated client. + +Please comment on [discussion #824](https://github.com/openapi-generators/openapi-python-client/discussions/824) +(or a new discussion, as appropriate) to aid in designing future features that fill any gaps this leaves for you. + +### Features + +#### Added an `--output-path` option to `generate` + +Rather than changing directories before running `generate` you can now specify an output directory with `--output-path`. +Note that the project name will _not_ be appended to the `--output-path`, whatever path you specify is where the +generated code will be placed. + +#### Added an `--overwrite` flag to `generate` + +You can now tell `openapi-python-client` to overwrite an existing directory, rather than deleting it yourself before +running `generate`. + ## 0.20.0 (2024-05-18) ### Breaking Changes diff --git a/pyproject.toml b/pyproject.toml index 0fc06b695..73005bf46 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -18,7 +18,7 @@ dependencies = [ "typing-extensions>=4.8.0,<5.0.0", ] name = "openapi-python-client" -version = "0.20.0" +version = "0.21.0" description = "Generate modern Python clients from OpenAPI" keywords = [ "OpenAPI",