OpenAPI: Automated Generate and Push #4
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: "OpenAPI: Automated Generate and Push" | |
| on: | |
| repository_dispatch: | |
| types: [generate_publish_release] | |
| workflow_dispatch: | |
| inputs: | |
| payload_json: | |
| description: 'JSON payload (e.g., {"api_versions":"v20111101","version":"patch","commit_sha":"abc123"})' | |
| required: false | |
| type: string | |
| jobs: | |
| Setup: | |
| runs-on: ubuntu-latest | |
| outputs: | |
| matrix: ${{ steps.set-matrix.outputs.matrix }} | |
| versions_to_generate: ${{ steps.parse-payload.outputs.versions_to_generate }} | |
| steps: | |
| - name: Parse payload | |
| id: parse-payload | |
| run: | | |
| # Parse workflow_dispatch payload if provided, otherwise use repository_dispatch payload | |
| if [ -n "${{ github.event.inputs.payload_json }}" ]; then | |
| VERSIONS=$(echo '${{ github.event.inputs.payload_json }}' | jq -r '.api_versions // "v20111101"') | |
| else | |
| VERSIONS="${{ github.event.client_payload.api_versions || 'v20111101' }}" | |
| fi | |
| echo "versions_to_generate=$VERSIONS" >> $GITHUB_OUTPUT | |
| - name: Set up matrix | |
| id: set-matrix | |
| run: | | |
| VERSIONS="${{ steps.parse-payload.outputs.versions_to_generate }}" | |
| echo "Versions to generate: $VERSIONS" | |
| # Build matrix JSON | |
| MATRIX_JSON='{"include":[' | |
| FIRST=true | |
| for VERSION in $(echo $VERSIONS | tr ',' ' '); do | |
| if [ "$FIRST" = false ]; then | |
| MATRIX_JSON+=',' | |
| fi | |
| FIRST=false | |
| # Map version to config file and major version | |
| if [ "$VERSION" = "v20111101" ]; then | |
| CONFIG="openapi/config-v20111101.yml" | |
| elif [ "$VERSION" = "v20250224" ]; then | |
| CONFIG="openapi/config-v20250224.yml" | |
| fi | |
| MATRIX_JSON+="{\"api_version\":\"$VERSION\",\"config_file\":\"$CONFIG\"}" | |
| done | |
| MATRIX_JSON+=']}' | |
| echo "matrix=$MATRIX_JSON" >> $GITHUB_OUTPUT | |
| echo "Matrix: $MATRIX_JSON" | |
| Generate: | |
| runs-on: ubuntu-latest | |
| needs: Setup | |
| strategy: | |
| matrix: ${{ fromJson(needs.Setup.outputs.matrix) }} | |
| fail-fast: false | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: actions/setup-node@v3 | |
| with: | |
| node-version: "20" | |
| - uses: ruby/setup-ruby@v1 | |
| with: | |
| ruby-version: 3.1 | |
| - name: Validate configuration | |
| run: ruby .github/config_validator.rb "${{ matrix.config_file }}" "${{ matrix.api_version }}" | |
| - name: Bump version | |
| id: bump_version | |
| run: | | |
| # Parse version from workflow_dispatch or repository_dispatch | |
| if [ -n "${{ github.event.inputs.payload_json }}" ]; then | |
| VERSION=$(echo '${{ github.event.inputs.payload_json }}' | jq -r '.version // "patch"') | |
| else | |
| VERSION="${{ github.event.client_payload.version || 'patch' }}" | |
| fi | |
| NEW_VERSION=$(ruby .github/version.rb "$VERSION" ${{ matrix.config_file }}) | |
| echo "version=$NEW_VERSION" >> $GITHUB_OUTPUT | |
| - name: Clean repo | |
| run: ruby .github/clean.rb ${{ matrix.api_version }} | |
| - name: Copy generator ignore rules | |
| run: | | |
| mkdir -p ./${{ matrix.api_version }}/ | |
| cp .openapi-generator-ignore ./${{ matrix.api_version }}/ | |
| - name: Install openapi-generator-cli | |
| run: npm install @openapitools/openapi-generator-cli -g | |
| - name: Generate SDK | |
| run: | | |
| # Parse commit_sha from workflow_dispatch or repository_dispatch | |
| if [ -n "${{ github.event.inputs.payload_json }}" ]; then | |
| COMMIT_SHA=$(echo '${{ github.event.inputs.payload_json }}' | jq -r '.commit_sha // "master"') | |
| else | |
| COMMIT_SHA="${{ github.event.client_payload.commit_sha || 'master' }}" | |
| fi | |
| # Versioned spec URLs with commit SHA to avoid GitHub CDN cache race condition | |
| # Problem: GitHub's raw.githubusercontent.com CDN caches files for 5 minutes | |
| # If openapi repo commits and immediately triggers this workflow, CDN may serve stale spec | |
| # Using commit SHA in URL to bypass cache and guarantee correct spec version | |
| # Falls back to 'master' if openapi doesn't send commit_sha | |
| openapi-generator-cli generate \ | |
| -i https://raw.githubusercontent.com/mxenabled/openapi/$COMMIT_SHA/openapi/${{ matrix.api_version }}.yml \ | |
| -g typescript-axios \ | |
| -c ${{ matrix.config_file }} \ | |
| -t ./openapi/templates \ | |
| -o ./${{ matrix.api_version }} | |
| - name: Upload artifacts | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: generated-${{ matrix.api_version }} | |
| path: ./${{ matrix.api_version }} | |
| Process-and-Push: | |
| runs-on: ubuntu-latest | |
| needs: [Setup, Generate] | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Download all artifacts | |
| uses: actions/download-artifact@v4 | |
| with: | |
| path: ./generated | |
| - name: Move generated files and track versions | |
| id: track_versions | |
| run: | | |
| GENERATED_VERSIONS="" | |
| for dir in ./generated/generated-*; do | |
| VERSION=$(basename "$dir" | sed 's/generated-//') | |
| mv "$dir" "./$VERSION" | |
| GENERATED_VERSIONS="$GENERATED_VERSIONS $VERSION" | |
| done | |
| echo "generated_versions=$GENERATED_VERSIONS" >> $GITHUB_OUTPUT | |
| - name: Update CHANGELOG | |
| run: | | |
| GENERATED_VERSIONS="${{ steps.track_versions.outputs.generated_versions }}" | |
| # Only update if something was generated | |
| if [ -z "$GENERATED_VERSIONS" ]; then | |
| echo "No versions generated, skipping changelog update" | |
| exit 0 | |
| fi | |
| # Convert space-separated versions to comma-separated for changelog_manager.rb | |
| VERSIONS_CSV=$(echo "$GENERATED_VERSIONS" | tr ' ' ',') | |
| ruby .github/changelog_manager.rb "$VERSIONS_CSV" | |
| - name: Copy documentation | |
| run: | | |
| GENERATED_VERSIONS="${{ steps.track_versions.outputs.generated_versions }}" | |
| for VERSION in $GENERATED_VERSIONS; do | |
| cp LICENSE "./$VERSION/LICENSE" | |
| cp CHANGELOG.md "./$VERSION/CHANGELOG.md" | |
| cp MIGRATION.md "./$VERSION/MIGRATION.md" | |
| done | |
| - name: Checkout master | |
| run: git checkout master | |
| - name: Create commit | |
| run: | | |
| git config user.name "devexperience" | |
| git config user.email "devexperience@mx.com" | |
| git add . | |
| git commit -m "Generated SDK versions: ${{ needs.Setup.outputs.versions_to_generate }} | |
| This commit was automatically created by a GitHub Action." | |
| - name: Push to master | |
| run: git push origin master | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |