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
OpenAPI specifications in the upstream `openapi` repository change → Repository sends `repository_dispatch` event to `mx-platform-node` → `generate_publish_release.yml` workflow is triggered
34
+
OpenAPI specifications in the upstream `openapi` repository change → Repository sends `repository_dispatch` event to `mx-platform-node` → `openapi-generate-and-push.yml` workflow is triggered
Copy file name to clipboardExpand all lines: docs/Adding-a-New-API-Version.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -108,9 +108,9 @@ 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 generate_publish_release.yml
111
+
### 2.2 Update openapi-generate-and-push.yml
112
112
113
-
This workflow is automatically triggered by the OpenAPI repository to generate and publish SDKs for all versions in parallel.
113
+
This workflow is automatically triggered by the OpenAPI repository to generate and push SDKs for all versions in parallel.
114
114
115
115
**Location 1: Version-to-config mapping**
116
116
@@ -198,7 +198,7 @@ Check that your YAML is valid for all three modified files:
@@ -364,7 +364,7 @@ Use this checklist to verify you've completed all steps:
364
364
-[ ] Major version in config is unique and sequential (4.0.0 for v20300101)
365
365
-[ ] Updated `.github/workflows/generate.yml` with new version in dropdown options
366
366
-[ ] Updated `.github/config_validator.rb` with new version in `SUPPORTED_VERSIONS` mapping
367
-
-[ ] Updated `.github/workflows/generate_publish_release.yml` with version-to-config mapping in Setup job
367
+
-[ ] Updated `.github/workflows/openapi-generate-and-push.yml` with version-to-config mapping in Setup job
368
368
-[ ] Updated `.github/changelog_manager.rb` with new version in `API_VERSION_ORDER` array
369
369
-[ ] Updated `.github/workflows/on-push-master.yml` path triggers with `v20300101/**`
370
370
-[ ] Updated `.github/workflows/on-push-master.yml` publish job matrix with new version
@@ -404,9 +404,9 @@ Use this checklist to verify you've completed all steps:
404
404
**Cause**: Wrong major version in config file
405
405
**Solution**: Update `npmVersion: 4.0.0` in config file to use unique major version
406
406
407
-
### generate_publish_release.yml doesn't recognize new version
407
+
### openapi-generate-and-push.yml doesn't recognize new version
408
408
**Cause**: Version-to-config mapping missing in Setup job, ChangelogManager not updated, or ConfigValidator not updated
409
-
**Solution**: Verify three locations are updated: (1) version-to-config mapping in generate_publish_release.yml Setup job, (2) add version to `API_VERSION_ORDER` in `changelog_manager.rb`, and (3) add version to `SUPPORTED_VERSIONS` in `config_validator.rb`
409
+
**Solution**: Verify three locations are updated: (1) version-to-config mapping in openapi-generate-and-push.yml Setup job, (2) add version to `API_VERSION_ORDER` in `changelog_manager.rb`, and (3) add version to `SUPPORTED_VERSIONS` in `config_validator.rb`
410
410
411
411
### on-push-master.yml doesn't trigger after merge
412
412
**Cause**: Path trigger syntax incorrect or matrix not updated
@@ -426,7 +426,7 @@ Once verified:
426
426
2.**Create PR**: Get code review of workflow changes
427
427
3.**Merge PR**: Once approved, merge to master
428
428
4.**Wait for OpenAPI updates**: New version won't generate until OpenAPI repo sends it in payload
429
-
5.**Monitor first generation**: Watch the automatic `generate_publish_release.yml` run when OpenAPI repo triggers it
429
+
5.**Monitor first generation**: Watch the automatic `openapi-generate-and-push.yml` run when OpenAPI repo triggers it
The `generate.yml` and `generate_publish_release.yml` workflows run configuration validation before SDK generation. If validation fails, the workflow stops immediately to prevent invalid configurations from generating code.
36
+
The `generate.yml` and `openapi-generate-and-push.yml` workflows run configuration validation before SDK generation. If validation fails, the workflow stops immediately to prevent invalid configurations from generating code.
37
37
38
38
**Validator**: `.github/config_validator.rb`
39
39
@@ -275,7 +275,7 @@ fatal: A release with this tag already exists
275
275
- Workflow runs at 2:02 PM but CDN still has 2:00 PM version
276
276
- SDK generated from stale spec
277
277
278
-
**Solution**: Already implemented in `generate_publish_release.yml`
278
+
**Solution**: Already implemented in `openapi-generate-and-push.yml`
279
279
- Uses commit SHA in spec URL: `raw.githubusercontent.com/mxenabled/openapi/<commit-sha>/openapi/v20111101.yml`
280
280
- Commit SHA bypasses CDN and guarantees exact spec version
#### Step 1: Setup - Determine Versions to Generate
27
27
@@ -130,7 +130,7 @@ strategy:
130
130
**Architecture**: After `Commit-and-Push` completes and pushes to master, the automatic `on-push-master.yml` workflow is triggered by GitHub's push event.
0 commit comments