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: docs/Adding-a-New-API-Version.md
+52-7Lines changed: 52 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -108,15 +108,56 @@ The `ConfigValidator` automatically validates that:
108
108
109
109
**No workflow changes needed** — the existing validation step in `generate.yml` calls `ConfigValidator` with your new version, and it automatically validates using the updated mapping.
110
110
111
-
### 2.2 Update openapi-generate-and-push.yml
111
+
### 2.2 Update release.yml and publish.yml
112
+
113
+
Both the `release.yml` and `publish.yml` workflows use `workflow_dispatch` with choice inputs to allow manual triggering with the correct version directory.
114
+
115
+
#### 2.2a Update release.yml
116
+
117
+
**Location: Workflow dispatch options**
118
+
119
+
In the `on.workflow_dispatch.inputs.version_directory.options` section, add the new version to the dropdown list:
120
+
121
+
```yaml
122
+
version_directory:
123
+
description: 'API version directory'
124
+
required: true
125
+
type: choice
126
+
options:
127
+
- v20111101
128
+
- v20250224
129
+
- v20300101 # NEW
130
+
```
131
+
132
+
#### 2.2b Update publish.yml
133
+
134
+
**Location: Workflow dispatch options**
135
+
136
+
In the `on.workflow_dispatch.inputs.version_directory.options` section, add the new version to the dropdown list:
137
+
138
+
```yaml
139
+
version_directory:
140
+
description: 'API version directory'
141
+
required: true
142
+
type: choice
143
+
options:
144
+
- v20111101
145
+
- v20250224
146
+
- v20300101 # NEW
147
+
```
148
+
149
+
**Why both workflows need updating**: These choices allow users to manually trigger release and publish workflows for any version. Adding the new version ensures it can be selected in the GitHub Actions UI when manually triggering these workflows.
150
+
151
+
### 2.3 Update openapi-generate-and-push.yml
112
152
113
153
This workflow is automatically triggered by the OpenAPI repository to generate and push SDKs for all versions in parallel.
114
154
115
155
**Location 1: Version-to-config mapping**
116
156
117
-
In the `Setup` job's `Set up matrix` step, add an `elif` branch to map your new version to its config file:
157
+
In the `Setup` job's `Set up matrix` step, find the section with the version-to-config mapping and add an `elif` branch for your new version:
This dynamically builds the matrix that determines which config file each version uses during generation.
170
+
This dynamically builds the matrix JSON that determines which config file each version uses during generation.
130
171
131
172
**Location 2: Add version to ChangelogManager priority order**
132
173
@@ -144,7 +185,7 @@ This ensures when multiple versions are generated, changelog entries appear in o
144
185
- Extracts date ranges from existing entries
145
186
- Inserts properly formatted entries at the top of the changelog
146
187
147
-
### 2.3 Update on-push-master.yml
188
+
### 2.4 Update on-push-master.yml
148
189
149
190
This workflow automatically triggers publish and release jobs when version directories are pushed to master. Since individual version jobs use conditional `if` statements based on path changes, you need to add new conditional jobs for your new version.
150
191
@@ -214,12 +255,14 @@ gate-v20250224-complete:
214
255
- Gate jobs use the `always()` condition so they run even when intermediate jobs are skipped
215
256
- This prevents npm registry race conditions and ensures correct behavior whether one or multiple versions are modified
216
257
217
-
### 2.4 Verify Workflow Syntax
258
+
### 2.5 Verify Workflow Syntax
218
259
219
-
Check that your YAML is valid for all three modified files:
260
+
Check that your YAML is valid for all four modified files:
Copy file name to clipboardExpand all lines: docs/Workflow-and-Configuration-Reference.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -129,7 +129,7 @@ strategy:
129
129
130
130
#### Step 5: Automatic Publish and Release (via on-push-master.yml)
131
131
132
-
**Architecture**: After `Commit-and-Push` completes and pushes to master, the automatic `on-push-master.yml` workflow is triggered by GitHub's push event.
132
+
**Architecture**: After `Process-and-Push` completes and pushes to master, the automatic `on-push-master.yml` workflow is triggered by GitHub's push event.
0 commit comments