Skip to content

Commit 2fc5340

Browse files
author
Genevieve Nuebel
committed
Rename generate_publish_release and all doc references
1 parent b1d5034 commit 2fc5340

6 files changed

Lines changed: 25 additions & 25 deletions

.github/workflows/generate_publish_release.yml renamed to .github/workflows/openapi-generate-and-push.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Generate Publish Release
1+
name: "OpenAPI: Automated Generate and Push"
22

33
on:
44
repository_dispatch:

docs/ARCHIVED/SDK-Generation-Publishing-Flow.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,11 @@ Both flows use the same underlying generation logic but differ in how they handl
3131
## Flow 1: Automatic Generation (Repository Dispatch)
3232

3333
### Trigger
34-
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
3535

3636
### Current Implementation
3737

38-
**Workflow**: `.github/workflows/generate_publish_release.yml`
38+
**Workflow**: `.github/workflows/openapi-generate-and-push.yml`
3939

4040
This is the **production flow** that automatically generates, publishes, and releases SDKs when upstream APIs change.
4141

@@ -233,7 +233,7 @@ supportsES6: true
233233
234234
**Used by**:
235235
- `generate.yml` (manual generation)
236-
- `generate_publish_release.yml` (automatic generation)
236+
- `openapi-generate-and-push.yml` (automatic generation)
237237
- `version.rb` script
238238

239239
### openapi/templates/
@@ -356,9 +356,9 @@ sequenceDiagram
356356
| `NPM_AUTH_TOKEN` | publish.yml | Authenticate to npm registry for publishing |
357357
| `GITHUB_TOKEN` | All workflows | GitHub API access (auto-provided, but sometimes explicitly referenced) |
358358
| `SLACK_WEBHOOK_URL` | All workflows | Send failure notifications to Slack |
359-
| `PAPI_SDK_APP_ID` | generate_publish_release.yml | GitHub App ID for custom token generation |
360-
| `PAPI_SDK_INSTALLATION_ID` | generate_publish_release.yml | GitHub App installation ID |
361-
| `PAPI_SDK_PRIVATE_KEY` | generate_publish_release.yml | GitHub App private key |
359+
| `PAPI_SDK_APP_ID` | openapi-generate-and-push.yml | GitHub App ID for custom token generation |
360+
| `PAPI_SDK_INSTALLATION_ID` | openapi-generate-and-push.yml | GitHub App installation ID |
361+
| `PAPI_SDK_PRIVATE_KEY` | openapi-generate-and-push.yml | GitHub App private key |
362362

363363
### Environment Setup
364364

docs/Adding-a-New-API-Version.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -108,9 +108,9 @@ The `ConfigValidator` automatically validates that:
108108

109109
**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.
110110

111-
### 2.2 Update generate_publish_release.yml
111+
### 2.2 Update openapi-generate-and-push.yml
112112

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.
114114

115115
**Location 1: Version-to-config mapping**
116116

@@ -198,7 +198,7 @@ Check that your YAML is valid for all three modified files:
198198

199199
```bash
200200
ruby -e "require 'yaml'; puts YAML.load(File.read('.github/workflows/generate.yml'))"
201-
ruby -e "require 'yaml'; puts YAML.load(File.read('.github/workflows/generate_publish_release.yml'))"
201+
ruby -e "require 'yaml'; puts YAML.load(File.read('.github/workflows/openapi-generate-and-push.yml'))"
202202
ruby -e "require 'yaml'; puts YAML.load(File.read('.github/workflows/on-push-master.yml'))"
203203
```
204204

@@ -364,7 +364,7 @@ Use this checklist to verify you've completed all steps:
364364
- [ ] Major version in config is unique and sequential (4.0.0 for v20300101)
365365
- [ ] Updated `.github/workflows/generate.yml` with new version in dropdown options
366366
- [ ] 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
368368
- [ ] Updated `.github/changelog_manager.rb` with new version in `API_VERSION_ORDER` array
369369
- [ ] Updated `.github/workflows/on-push-master.yml` path triggers with `v20300101/**`
370370
- [ ] 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:
404404
**Cause**: Wrong major version in config file
405405
**Solution**: Update `npmVersion: 4.0.0` in config file to use unique major version
406406

407-
### generate_publish_release.yml doesn't recognize new version
407+
### openapi-generate-and-push.yml doesn't recognize new version
408408
**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`
410410

411411
### on-push-master.yml doesn't trigger after merge
412412
**Cause**: Path trigger syntax incorrect or matrix not updated
@@ -426,7 +426,7 @@ Once verified:
426426
2. **Create PR**: Get code review of workflow changes
427427
3. **Merge PR**: Once approved, merge to master
428428
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
430430

431431
---
432432

docs/Multi-Version-SDK-Flow.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Each version is independently generated, tested, published to npm, and released
2828
## Three Ways Things Happen
2929

3030
### 🤖 Flow 1: Automatic (Upstream Triggers)
31-
OpenAPI spec changes → `generate_publish_release.yml` runs → SDK generated, published, released
31+
OpenAPI spec changes → `openapi-generate-and-push.yml` runs → SDK generated, published, released
3232

3333
**When**: OpenAPI repository sends `repository_dispatch` with API versions
3434
**Who**: Automated, no human intervention
@@ -173,15 +173,15 @@ sequenceDiagram
173173

174174
| File | Purpose | Used By |
175175
|------|---------|---------|
176-
| `.github/workflows/generate_publish_release.yml` | Automatic generation from upstream API changes | OpenAPI repo |
176+
| `.github/workflows/openapi-generate-and-push.yml` | Automatic generation from upstream API changes | OpenAPI repo |
177177
| `.github/workflows/generate.yml` | Manual generation with version selection | Developer |
178178
| `.github/workflows/on-push-master.yml` | Auto-publish trigger with path-based matrix | Any master push |
179179
| `.github/workflows/publish.yml` | Publishes SDK to npm | publish_release & on-push-master |
180180
| `.github/workflows/release.yml` | Creates GitHub release | publish_release & on-push-master |
181181
| `.github/version.rb` | Bumps version in config files | Workflows |
182182
| `.github/clean.rb` | Removes old generated files | Workflows |
183-
| `openapi/config-v20111101.yml` | Config for v20111101 generation | generate_publish_release & generate |
184-
| `openapi/config-v20250224.yml` | Config for v20250224 generation | generate_publish_release & generate |
183+
| `openapi/config-v20111101.yml` | Config for v20111101 generation | openapi-generate-and-push & generate |
184+
| `openapi/config-v20250224.yml` | Config for v20250224 generation | openapi-generate-and-push & generate |
185185
| `openapi/templates/package.mustache` | npm package.json template | OpenAPI Generator |
186186
| `openapi/templates/README.mustache` | README.md template | OpenAPI Generator |
187187

docs/Troubleshooting-Guide.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Check in this order:
3333

3434
### Generate Workflow: Configuration Validation Fails
3535

36-
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.
3737

3838
**Validator**: `.github/config_validator.rb`
3939

@@ -275,7 +275,7 @@ fatal: A release with this tag already exists
275275
- Workflow runs at 2:02 PM but CDN still has 2:00 PM version
276276
- SDK generated from stale spec
277277

278-
**Solution**: Already implemented in `generate_publish_release.yml`
278+
**Solution**: Already implemented in `openapi-generate-and-push.yml`
279279
- Uses commit SHA in spec URL: `raw.githubusercontent.com/mxenabled/openapi/<commit-sha>/openapi/v20111101.yml`
280280
- Commit SHA bypasses CDN and guarantees exact spec version
281281
- Nothing to do—this is automatic

docs/Workflow-and-Configuration-Reference.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
## Flow 1: Automatic Multi-Version Generation (Repository Dispatch)
1111

1212
### Trigger
13-
OpenAPI specifications change in the upstream `openapi` repository → Repository sends `repository_dispatch` event with optional `api_versions` payload → `generate_publish_release.yml` workflow is triggered
13+
OpenAPI specifications change in the upstream `openapi` repository → Repository sends `repository_dispatch` event with optional `api_versions` payload → `openapi-generate-and-push.yml` workflow is triggered
1414

1515
### Backward Compatibility Model
1616
- **No Payload (v20111101 only)**: If openapi repo sends `repository_dispatch` without `api_versions` field, defaults to generating v20111101 only
@@ -21,7 +21,7 @@ This allows phased migration: current behavior works as-is, and when the openapi
2121

2222
### Implementation
2323

24-
**Workflow**: `.github/workflows/generate_publish_release.yml`
24+
**Workflow**: `.github/workflows/openapi-generate-and-push.yml`
2525

2626
#### Step 1: Setup - Determine Versions to Generate
2727

@@ -130,7 +130,7 @@ strategy:
130130
**Architecture**: After `Commit-and-Push` completes and pushes to master, the automatic `on-push-master.yml` workflow is triggered by GitHub's push event.
131131
132132
**Why This Architecture?**
133-
- Separates concerns: `generate_publish_release.yml` owns generation, `on-push-master.yml` owns publishing
133+
- Separates concerns: `openapi-generate-and-push.yml` owns generation, `on-push-master.yml` owns publishing
134134
- Enables consistent publish logic: All publishes (whether from automated generation or manual PR merge) go through the same workflow
135135
- Prevents duplicate publishes: Manual generate.yml + PR merge only triggers publish once (via on-push-master.yml)
136136
@@ -431,7 +431,7 @@ The `npmVersion` field in the config file is the **authoritative source of truth
431431

432432
**When It's Called**:
433433
- `generate.yml`: After generating a single API version (manual flow)
434-
- `generate_publish_release.yml`: After generating multiple API versions (automatic flow)
434+
- `openapi-generate-and-push.yml`: After generating multiple API versions (automatic flow)
435435

436436
**Example Output**:
437437
```markdown
@@ -604,7 +604,7 @@ OpenAPI Repo: Commits change to v20111101.yml and v20250224.yml
604604
605605
repository_dispatch: {"api_versions": "v20111101,v20250224"}
606606
607-
generate_publish_release.yml: Triggered
607+
openapi-generate-and-push.yml: Triggered
608608
├─ Setup: Create matrix from api_versions
609609
├─ Matrix[v20111101]: Clean, Bump, Generate (parallel)
610610
├─ Matrix[v20250224]: Clean, Bump, Generate (parallel)

0 commit comments

Comments
 (0)