Skip to content

Conversation

@Gvieve
Copy link
Collaborator

@Gvieve Gvieve commented Jan 27, 2026

Overview

Implements Part 5 of the multi-version SDK support for mx-platform-node, enabling the same npm package to publish multiple API versions as independent major versions:

  • mx-platform-node@2.x.x = API v20111101
  • mx-platform-node@3.x.x = API v20250224

Key Changes

Infrastructure Updates

  • Updated supporting scripts (clean.rb, version.rb) for multi-version operations, remove ability to bump major version
  • Added version_directory parameter to publish.yml and release.yml workflows
  • Implemented matrix-based job execution in on-push-master.yml for parallel version handling

Automation Improvements

  • Enhanced generate.yml with version selection dropdown and update bump version to add skip and remove major as option
  • Updated generate_publish_release.yml with matrix strategy and add commit SHA support for OAS file retrieval
    • this bypasses CDN cache race condition where SDK is generated with cached url that has no changes
  • Added skip-publish safety flag to prevent spurious publishes during structural changes

Templates & Documentation

  • Updated package.mustache to include new apiVersion field and description for consumer discovery
  • Updated README.mustache with API version identification section
  • Updated MIGRATION.md with v20250224 upgrade path
  • Added Documentation - Implementation guides, troubleshooting, and workflow references

Directory Structure

  • Migrated latest/v20111101/ to align with semantic versioning
  • Staged with [skip-publish] flag to prevent publish during structural change

Testing

  • Ready for GitHub Actions testing on merge
  • Integration testing with openapi repository dispatch to follow

@Gvieve Gvieve self-assigned this Jan 27, 2026
@Gvieve Gvieve added the enhancement New feature or request label Jan 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants