From 2c96ab0537dab6798a95f778d004ccea9deef8c2 Mon Sep 17 00:00:00 2001 From: ewaostrowska <214632419+ewaostrowska@users.noreply.github.com> Date: Thu, 14 May 2026 10:31:39 +0000 Subject: [PATCH] chore: fix formatting of the compatibility and readme --- CI/release/update-codegen-release-files.py | 25 +++++++++++++++---- README.md | 8 +++--- docs/compatibility.md | 7 +++--- docs/prerequisites.md | 4 +-- docs/versioning.md | 2 +- modules/swagger-codegen-cli/pom.xml | 2 +- modules/swagger-codegen-maven-plugin/pom.xml | 2 +- modules/swagger-codegen/pom.xml | 2 +- modules/swagger-generator/pom.xml | 2 +- .../src/main/resources/openapi.yaml | 2 +- pom.docker.xml | 4 +-- pom.xml | 4 +-- samples/meta-codegen/pom.xml | 4 +-- 13 files changed, 43 insertions(+), 25 deletions(-) diff --git a/CI/release/update-codegen-release-files.py b/CI/release/update-codegen-release-files.py index 9ec93b110bb..0e80575a1e7 100644 --- a/CI/release/update-codegen-release-files.py +++ b/CI/release/update-codegen-release-files.py @@ -9,11 +9,11 @@ # Regex patterns intentionally target release tables/examples used in public docs. SNAPSHOT_ROW_PATTERN = ( - r"\|?\s*[0-9]+\.[0-9]+\.[0-9]+-SNAPSHOT \(current 3\.0\.0, upcoming minor release\).*?\|\s*Minor release\s*\|?" + r"^\|[ \t]*[0-9]+\.[0-9]+\.[0-9]+-SNAPSHOT \(current 3\.0\.0, upcoming minor release\).*?\|[ \t]*Minor release[ \t]*\|[ \t]*$" ) RELEASE_ROW_PATTERN = ( - r"\| \[[0-9]+\.[0-9]+\.[0-9]+\]\(https://github\.com/swagger-api/swagger-codegen/releases/tag/v[0-9]+\.[0-9]+\.[0-9]+\) " - r"(?:\(\*\*current stable\*\*\)\s*)?.*?\| \[tag v[0-9]+\.[0-9]+\.[0-9]+\]\(https://github\.com/swagger-api/swagger-codegen/tree/v[0-9]+\.[0-9]+\.[0-9]+\)\s*\|" + r"^\| \[[0-9]+\.[0-9]+\.[0-9]+\]\(https://github\.com/swagger-api/swagger-codegen/releases/tag/v[0-9]+\.[0-9]+\.[0-9]+\) " + r"(?:\(\*\*current stable\*\*\)[ \t]*)?.*?\| \[tag v[0-9]+\.[0-9]+\.[0-9]+\]\(https://github\.com/swagger-api/swagger-codegen/tree/v[0-9]+\.[0-9]+\.[0-9]+\)\|?[ \t]*$" ) RELEASE_JAR_PATTERN = ( r"io/swagger/codegen/v3/swagger-codegen-cli/[0-9]+\.[0-9]+\.[0-9]+/swagger-codegen-cli-[0-9]+\.[0-9]+\.[0-9]+\.jar" @@ -78,6 +78,19 @@ def update_sample_meta_codegen_pom(codegen_version: str) -> None: ) +def update_sample_meta_codegen_generators_version(generators_version: str) -> None: + # Keep sample project generators property aligned with release generators version. + replace_text( + "samples/meta-codegen/pom.xml", + [ + ( + r"[^<]+", + f"{generators_version}", + ) + ], + ) + + def update_docker_pom_version(codegen_version: str) -> None: # Keep root project version in pom.docker.xml aligned with released codegen version. replace_text( @@ -97,9 +110,9 @@ def update_openapi_version(version: str) -> None: def update_snapshot_rows(next_snapshot: str) -> None: # Update "current upcoming snapshot" row in compatibility docs. snapshot_row = ( - f"{next_snapshot} (current 3.0.0, upcoming minor release) " + f"| {next_snapshot} (current 3.0.0, upcoming minor release) " "[SNAPSHOT](https://central.sonatype.com/service/rest/repository/browse/maven-snapshots/" - f"io/swagger/codegen/v3/swagger-codegen-cli/{next_snapshot}/)| TBD | 1.0, 1.1, 1.2, 2.0, 3.0 | Minor release" + f"io/swagger/codegen/v3/swagger-codegen-cli/{next_snapshot}/) | TBD | 1.0, 1.1, 1.2, 2.0, 3.0 | Minor release |" ) replace_text_in_docs(COMPATIBILITY_DOCS, [(SNAPSHOT_ROW_PATTERN, snapshot_row)], require_match=True) @@ -156,6 +169,7 @@ def main() -> int: codegen_version, next_snapshot, generators_version = sys.argv[2:5] update_generators_poms(generators_version) update_sample_meta_codegen_pom(codegen_version) + update_sample_meta_codegen_generators_version(generators_version) update_docker_pom_version(codegen_version) update_openapi_version(codegen_version) update_snapshot_rows(next_snapshot) @@ -170,6 +184,7 @@ def main() -> int: return 2 next_snapshot, generators_version = sys.argv[2:4] update_generators_poms(generators_version) + update_sample_meta_codegen_generators_version(generators_version) update_docker_pom_version(next_snapshot) update_openapi_version(next_snapshot) update_snapshot_rows(next_snapshot) diff --git a/README.md b/README.md index df5bffde10d..42e0a571798 100644 --- a/README.md +++ b/README.md @@ -84,13 +84,15 @@ The OpenAPI Specification has undergone 3 revisions since initial creation in 20 | Swagger Codegen Version | Release Date | Swagger / OpenAPI Spec compatibility | Notes | |----------------------------------------------------------------------------------------------------|--------------|--------------------------------------|----------------------------------------------------------------------------| -| [3.0.80](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.80) (**current stable**) | TBD | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.80](https://github.com/swagger-api/swagger-codegen/tree/v3.0.80) | +| [3.0.81](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.81) (**current stable**) | TBD | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.81](https://github.com/swagger-api/swagger-codegen/tree/v3.0.81) | | [2.4.52](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.52) (**current stable**) | 2026-04-15 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.52](https://github.com/swagger-api/swagger-codegen/tree/v2.4.52) | 💁 Here's also an overview of what's coming around the corner: | Swagger Codegen Version | Release Date | Swagger / OpenAPI Spec compatibility | Notes | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------|--------------------------------------|---------------3.0.81-SNAPSHOT (current 3.0.0, upcoming minor release) [SNAPSHOT](https://central.sonatype.com/service/rest/repository/browse/maven-snapshots/io/swagger/codegen/v3/swagger-codegen-cli/3.0.81-SNAPSHOT/)| TBD | 1.0, 1.1, 1.2, 2.0, 3.0 | Minor release 2.4.53-SNAPSHOT (current master, upcoming minor release) [SNAPSHOT](https://central.sonatype.com/service/rest/repository/browse/maven-snapshots/io/swagger/swagger-codegen-cli/2.4.53-SNAPSHOT/) | TBD | 1.0, 1.1, 1.2, 2.0 | Minor release | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------|--------------------------------------|---------------| +| 3.0.82-SNAPSHOT (current 3.0.0, upcoming minor release) [SNAPSHOT](https://central.sonatype.com/service/rest/repository/browse/maven-snapshots/io/swagger/codegen/v3/swagger-codegen-cli/3.0.82-SNAPSHOT/) | TBD | 1.0, 1.1, 1.2, 2.0, 3.0 | Minor release | +| 2.4.53-SNAPSHOT (current master, upcoming minor release) [SNAPSHOT](https://central.sonatype.com/service/rest/repository/browse/maven-snapshots/io/swagger/swagger-codegen-cli/2.4.53-SNAPSHOT/) | TBD | 1.0, 1.1, 1.2, 2.0 | Minor release | For detailed breakdown of all versions, please see the [full compatibility listing](./docs/compatibility.md). @@ -124,7 +126,7 @@ java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ java -jar modules\swagger-codegen-cli\target\swagger-codegen-cli.jar generate -i http://petstore.swagger.io/v2/swagger.json -l php -o c:\temp\php_api_client ``` -You can also download the JAR (latest release) directly from [maven.org](https://repo1.maven.org/maven2/io/swagger/codegen/v3/swagger-codegen-cli/3.0.80/swagger-codegen-cli-3.0.80.jar). +You can also download the JAR (latest release) directly from [maven.org](https://repo1.maven.org/maven2/io/swagger/codegen/v3/swagger-codegen-cli/3.0.81/swagger-codegen-cli-3.0.81.jar). To get a list of **general** options available, please run: diff --git a/docs/compatibility.md b/docs/compatibility.md index 136135bc2ca..a92165bb361 100644 --- a/docs/compatibility.md +++ b/docs/compatibility.md @@ -2,9 +2,10 @@ The Swagger Codegen project has the following compatibilities with the OpenAPI Specification (formerly known as Swagger): -| Swagger Codegen Version | Release Date | OpenAPI Spec compatibility | Notes | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------|----------------------------|---------------------------------------------------------------------------------------------3.0.81-SNAPSHOT (current 3.0.0, upcoming minor release) [SNAPSHOT](https://central.sonatype.com/service/rest/repository/browse/maven-snapshots/io/swagger/codegen/v3/swagger-codegen-cli/3.0.81-SNAPSHOT/)| TBD | 1.0, 1.1, 1.2, 2.0, 3.0 | Minor release [3.0.80](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.80) (**current stable**) | TBD | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.80](https://github.com/swagger-api/swagger-codegen/tree/v3.0.80) | -| [3.0.78](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.78) | 2026-02-17 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.78](https://github.com/swagger-api/swagger-codegen/tree/v3.0.78) | +| Swagger Codegen Version | Release Date | OpenAPI Spec compatibility | Notes | +|---|---|---|---| +| 3.0.82-SNAPSHOT (current 3.0.0, upcoming minor release) [SNAPSHOT](https://central.sonatype.com/service/rest/repository/browse/maven-snapshots/io/swagger/codegen/v3/swagger-codegen-cli/3.0.82-SNAPSHOT/) | TBD | 1.0, 1.1, 1.2, 2.0, 3.0 | Minor release | +| [3.0.81](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.81) (**current stable**) | TBD | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.81](https://github.com/swagger-api/swagger-codegen/tree/v3.0.81) | | [3.0.77](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.77) | 2026-02-03 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.77](https://github.com/swagger-api/swagger-codegen/tree/v3.0.77) | | [3.0.76](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.76) | 2026-01-20 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.76](https://github.com/swagger-api/swagger-codegen/tree/v3.0.76) | | [3.0.75](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.75) | 2025-10-14 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.75](https://github.com/swagger-api/swagger-codegen/tree/v3.0.75) | diff --git a/docs/prerequisites.md b/docs/prerequisites.md index 283c90796f3..92c4bda417b 100644 --- a/docs/prerequisites.md +++ b/docs/prerequisites.md @@ -3,7 +3,7 @@ If you're looking for the latest stable version, you can grab it directly from Maven.org (Java 8 runtime at a minimum): ```sh -wget https://repo1.maven.org/maven2/io/swagger/codegen/v3/swagger-codegen-cli/3.0.80/swagger-codegen-cli-3.0.80.jar -O swagger-codegen-cli.jar +wget https://repo1.maven.org/maven2/io/swagger/codegen/v3/swagger-codegen-cli/3.0.81/swagger-codegen-cli-3.0.81.jar -O swagger-codegen-cli.jar java -jar swagger-codegen-cli.jar --help ``` @@ -11,7 +11,7 @@ java -jar swagger-codegen-cli.jar --help For Windows users, you will need to install [wget](http://gnuwin32.sourceforge.net/packages/wget.htm) or you can use Invoke-WebRequest in PowerShell (3.0+). For example: ```powershell -Invoke-WebRequest -OutFile swagger-codegen-cli.jar https://repo1.maven.org/maven2/io/swagger/codegen/v3/swagger-codegen-cli/3.0.80/swagger-codegen-cli-3.0.80.jar +Invoke-WebRequest -OutFile swagger-codegen-cli.jar https://repo1.maven.org/maven2/io/swagger/codegen/v3/swagger-codegen-cli/3.0.81/swagger-codegen-cli-3.0.81.jar ``` On a Mac, it's even easier with `brew`: diff --git a/docs/versioning.md b/docs/versioning.md index 6776b4ac50a..0c6aff6f24e 100644 --- a/docs/versioning.md +++ b/docs/versioning.md @@ -40,6 +40,6 @@ dependency example: io.swagger.codegen.v3 swagger-codegen-maven-plugin - 3.0.80 + 3.0.81 ``` diff --git a/modules/swagger-codegen-cli/pom.xml b/modules/swagger-codegen-cli/pom.xml index bb70b28939f..00ff517a185 100644 --- a/modules/swagger-codegen-cli/pom.xml +++ b/modules/swagger-codegen-cli/pom.xml @@ -3,7 +3,7 @@ io.swagger.codegen.v3 swagger-codegen-project - 3.0.81-SNAPSHOT + 3.0.81 ../.. 4.0.0 diff --git a/modules/swagger-codegen-maven-plugin/pom.xml b/modules/swagger-codegen-maven-plugin/pom.xml index 0c41f158297..22c25b048a1 100644 --- a/modules/swagger-codegen-maven-plugin/pom.xml +++ b/modules/swagger-codegen-maven-plugin/pom.xml @@ -6,7 +6,7 @@ io.swagger.codegen.v3 swagger-codegen-project - 3.0.81-SNAPSHOT + 3.0.81 ../.. swagger-codegen-maven-plugin diff --git a/modules/swagger-codegen/pom.xml b/modules/swagger-codegen/pom.xml index 4927ff29441..ed868b5ad33 100644 --- a/modules/swagger-codegen/pom.xml +++ b/modules/swagger-codegen/pom.xml @@ -3,7 +3,7 @@ io.swagger.codegen.v3 swagger-codegen-project - 3.0.81-SNAPSHOT + 3.0.81 ../.. 4.0.0 diff --git a/modules/swagger-generator/pom.xml b/modules/swagger-generator/pom.xml index 3a6356433f8..330c839118e 100644 --- a/modules/swagger-generator/pom.xml +++ b/modules/swagger-generator/pom.xml @@ -4,7 +4,7 @@ io.swagger.codegen.v3 swagger-codegen-project - 3.0.81-SNAPSHOT + 3.0.81 ../.. swagger-generator diff --git a/modules/swagger-generator/src/main/resources/openapi.yaml b/modules/swagger-generator/src/main/resources/openapi.yaml index 662b7f6c988..a086ba7c982 100644 --- a/modules/swagger-generator/src/main/resources/openapi.yaml +++ b/modules/swagger-generator/src/main/resources/openapi.yaml @@ -4,7 +4,7 @@ servers: info: description: 'This is an online swagger codegen server. You can find out more at https://github.com/swagger-api/swagger-codegen or on [irc.freenode.net, #swagger](http://swagger.io/irc/).' - version: 3.0.81-SNAPSHOT + version: 3.0.81 title: Swagger Generator license: name: Apache 2.0 diff --git a/pom.docker.xml b/pom.docker.xml index ed228ba38ea..683913c921d 100644 --- a/pom.docker.xml +++ b/pom.docker.xml @@ -5,7 +5,7 @@ pom swagger-codegen-project swagger-codegen-project - 3.0.81-SNAPSHOT + 3.0.81 https://github.com/swagger-api/swagger-codegen scm:git:git@github.com:swagger-api/swagger-codegen.git @@ -1042,7 +1042,7 @@ 8 - 1.0.61 + 1.0.62 2.2.35 1.6.15 2.1.33 diff --git a/pom.xml b/pom.xml index 0cb29f084d6..4e4b2ebab21 100644 --- a/pom.xml +++ b/pom.xml @@ -5,7 +5,7 @@ pom swagger-codegen-project swagger-codegen-project - 3.0.81-SNAPSHOT + 3.0.81 https://github.com/swagger-api/swagger-codegen scm:git:git@github.com:swagger-api/swagger-codegen.git @@ -1057,7 +1057,7 @@ 8 - 1.0.61 + 1.0.62 2.2.48 1.6.16 2.1.40 diff --git a/samples/meta-codegen/pom.xml b/samples/meta-codegen/pom.xml index 5c2933fd3c1..c87baf2e0ca 100644 --- a/samples/meta-codegen/pom.xml +++ b/samples/meta-codegen/pom.xml @@ -120,8 +120,8 @@ UTF-8 - 3.0.80 - 1.0.61 + 3.0.81 + 1.0.62 1.0.0 4.13.2 3.0.0