Skip to content

Commit 6a2ff5a

Browse files
ewaostrowskaewaostrowska
committed
chore: fix formatting of the compatibility and readme
1 parent 32cf8e3 commit 6a2ff5a

13 files changed

Lines changed: 43 additions & 25 deletions

File tree

‎CI/release/update-codegen-release-files.py‎

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@
99

1010
# Regex patterns intentionally target release tables/examples used in public docs.
1111
SNAPSHOT_ROW_PATTERN = (
12-
r"\|?\s*[0-9]+\.[0-9]+\.[0-9]+-SNAPSHOT \(current 3\.0\.0, upcoming minor release\).*?\|\s*Minor release\s*\|?"
12+
r"^\|[ \t]*[0-9]+\.[0-9]+\.[0-9]+-SNAPSHOT \(current 3\.0\.0, upcoming minor release\).*?\|[ \t]*Minor release[ \t]*\|[ \t]*$"
1313
)
1414
RELEASE_ROW_PATTERN = (
15-
r"\| \[[0-9]+\.[0-9]+\.[0-9]+\]\(https://github\.com/swagger-api/swagger-codegen/releases/tag/v[0-9]+\.[0-9]+\.[0-9]+\) "
16-
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*\|"
15+
r"^\| \[[0-9]+\.[0-9]+\.[0-9]+\]\(https://github\.com/swagger-api/swagger-codegen/releases/tag/v[0-9]+\.[0-9]+\.[0-9]+\) "
16+
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]*$"
1717
)
1818
RELEASE_JAR_PATTERN = (
1919
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:
7878
)
7979

8080

81+
def update_sample_meta_codegen_generators_version(generators_version: str) -> None:
82+
# Keep sample project generators property aligned with release generators version.
83+
replace_text(
84+
"samples/meta-codegen/pom.xml",
85+
[
86+
(
87+
r"<swagger-codegen-generators-version>[^<]+</swagger-codegen-generators-version>",
88+
f"<swagger-codegen-generators-version>{generators_version}</swagger-codegen-generators-version>",
89+
)
90+
],
91+
)
92+
93+
8194
def update_docker_pom_version(codegen_version: str) -> None:
8295
# Keep root project version in pom.docker.xml aligned with released codegen version.
8396
replace_text(
@@ -97,9 +110,9 @@ def update_openapi_version(version: str) -> None:
97110
def update_snapshot_rows(next_snapshot: str) -> None:
98111
# Update "current upcoming snapshot" row in compatibility docs.
99112
snapshot_row = (
100-
f"{next_snapshot} (current 3.0.0, upcoming minor release) "
113+
f"| {next_snapshot} (current 3.0.0, upcoming minor release) "
101114
"[SNAPSHOT](https://central.sonatype.com/service/rest/repository/browse/maven-snapshots/"
102-
f"io/swagger/codegen/v3/swagger-codegen-cli/{next_snapshot}/)| TBD | 1.0, 1.1, 1.2, 2.0, 3.0 | Minor release"
115+
f"io/swagger/codegen/v3/swagger-codegen-cli/{next_snapshot}/) | TBD | 1.0, 1.1, 1.2, 2.0, 3.0 | Minor release |"
103116
)
104117
replace_text_in_docs(COMPATIBILITY_DOCS, [(SNAPSHOT_ROW_PATTERN, snapshot_row)], require_match=True)
105118

@@ -156,6 +169,7 @@ def main() -> int:
156169
codegen_version, next_snapshot, generators_version = sys.argv[2:5]
157170
update_generators_poms(generators_version)
158171
update_sample_meta_codegen_pom(codegen_version)
172+
update_sample_meta_codegen_generators_version(generators_version)
159173
update_docker_pom_version(codegen_version)
160174
update_openapi_version(codegen_version)
161175
update_snapshot_rows(next_snapshot)
@@ -170,6 +184,7 @@ def main() -> int:
170184
return 2
171185
next_snapshot, generators_version = sys.argv[2:4]
172186
update_generators_poms(generators_version)
187+
update_sample_meta_codegen_generators_version(generators_version)
173188
update_docker_pom_version(next_snapshot)
174189
update_openapi_version(next_snapshot)
175190
update_snapshot_rows(next_snapshot)

‎README.md‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -84,13 +84,15 @@ The OpenAPI Specification has undergone 3 revisions since initial creation in 20
8484

8585
| Swagger Codegen Version | Release Date | Swagger / OpenAPI Spec compatibility | Notes |
8686
|----------------------------------------------------------------------------------------------------|--------------|--------------------------------------|----------------------------------------------------------------------------|
87-
| [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) |
87+
| [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) |
8888
| [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) |
8989

9090
💁 Here's also an overview of what's coming around the corner:
9191

9292
| Swagger Codegen Version | Release Date | Swagger / OpenAPI Spec compatibility | Notes |
93-
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------|--------------------------------------|---------------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 |
93+
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------|--------------------------------------|---------------|
94+
| 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 |
95+
| 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 |
9496

9597
For detailed breakdown of all versions, please see the [full compatibility listing](./docs/compatibility.md).
9698

@@ -124,7 +126,7 @@ java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \
124126
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
125127
```
126128

127-
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).
129+
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).
128130

129131
To get a list of **general** options available, please run:
130132

‎docs/compatibility.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,10 @@
22

33
The Swagger Codegen project has the following compatibilities with the OpenAPI Specification (formerly known as Swagger):
44

5-
| Swagger Codegen Version | Release Date | OpenAPI Spec compatibility | Notes |
6-
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------|----------------------------|---------------------------------------------------------------------------------------------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) |
7-
| [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) |
5+
| Swagger Codegen Version | Release Date | OpenAPI Spec compatibility | Notes |
6+
|---|---|---|---|
7+
| 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 |
8+
| [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) |
89
| [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) |
910
| [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) |
1011
| [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) |

‎docs/prerequisites.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@
33
If you're looking for the latest stable version, you can grab it directly from Maven.org (Java 8 runtime at a minimum):
44

55
```sh
6-
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
6+
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
77

88
java -jar swagger-codegen-cli.jar --help
99
```
1010

1111
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:
1212

1313
```powershell
14-
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
14+
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
1515
```
1616

1717
On a Mac, it's even easier with `brew`:

‎docs/versioning.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,6 @@ dependency example:
4040
<dependency>
4141
<groupId>io.swagger.codegen.v3</groupId>
4242
<artifactId>swagger-codegen-maven-plugin</artifactId>
43-
<version>3.0.80</version>
43+
<version>3.0.81</version>
4444
</dependency>
4545
```

‎modules/swagger-codegen-cli/pom.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<parent>
44
<groupId>io.swagger.codegen.v3</groupId>
55
<artifactId>swagger-codegen-project</artifactId>
6-
<version>3.0.81-SNAPSHOT</version>
6+
<version>3.0.81</version>
77
<relativePath>../..</relativePath>
88
</parent>
99
<modelVersion>4.0.0</modelVersion>

‎modules/swagger-codegen-maven-plugin/pom.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<parent>
77
<groupId>io.swagger.codegen.v3</groupId>
88
<artifactId>swagger-codegen-project</artifactId>
9-
<version>3.0.81-SNAPSHOT</version>
9+
<version>3.0.81</version>
1010
<relativePath>../..</relativePath>
1111
</parent>
1212
<artifactId>swagger-codegen-maven-plugin</artifactId>

‎modules/swagger-codegen/pom.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<parent>
44
<groupId>io.swagger.codegen.v3</groupId>
55
<artifactId>swagger-codegen-project</artifactId>
6-
<version>3.0.81-SNAPSHOT</version>
6+
<version>3.0.81</version>
77
<relativePath>../..</relativePath>
88
</parent>
99
<modelVersion>4.0.0</modelVersion>

‎modules/swagger-generator/pom.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<parent>
55
<groupId>io.swagger.codegen.v3</groupId>
66
<artifactId>swagger-codegen-project</artifactId>
7-
<version>3.0.81-SNAPSHOT</version>
7+
<version>3.0.81</version>
88
<relativePath>../..</relativePath>
99
</parent>
1010
<artifactId>swagger-generator</artifactId>

‎modules/swagger-generator/src/main/resources/openapi.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ servers:
44
info:
55
description: 'This is an online swagger codegen server. You can find out more at
66
https://github.com/swagger-api/swagger-codegen or on [irc.freenode.net, #swagger](http://swagger.io/irc/).'
7-
version: 3.0.81-SNAPSHOT
7+
version: 3.0.81
88
title: Swagger Generator
99
license:
1010
name: Apache 2.0

0 commit comments

Comments
 (0)