release-sdk.yml

name: 'Release SDK'

on:
  workflow_dispatch:
    inputs:
      version:
        description: 'The version to release (e.g., v0.1.11). Required for manual patch releases.'
        required: false
        type: 'string'
      ref:
        description: 'The branch or ref (full git sha) to release SDK from.'
        required: true
        type: 'string'
        default: 'main'
      cli_source:
        description: 'CLI source to bundle. "build_from_source" builds CLI from the current branch/ref (recommended when releasing CLI and SDK together). "npm_latest" uses the latest stable CLI from npm (recommended for standalone SDK releases).'
        required: true
        type: 'choice'
        options:
          - 'build_from_source'
          - 'npm_latest'
        default: 'npm_latest'
      dry_run:
        description: 'Run a dry-run of the release process; no branches, npm packages or GitHub releases will be created.'
        required: true
        type: 'boolean'
        default: true
      create_nightly_release:
        description: 'Auto apply the nightly release tag, input version is ignored.'
        required: false
        type: 'boolean'
        default: false
      create_preview_release:
        description: 'Auto apply the preview release tag, input version is ignored.'
        required: false
        type: 'boolean'
        default: false
      force_skip_tests:
        description: 'Select to skip the "Run Tests" step in testing. Prod releases should run tests'
        required: false
        type: 'boolean'
        default: false

concurrency:
  group: '${{ github.workflow }}'
  cancel-in-progress: false

jobs:
  release-sdk:
    runs-on: 'ubuntu-latest'
    environment:
      name: 'production-release'
      url: '${{ github.server_url }}/${{ github.repository }}/releases/tag/sdk-typescript-${{ steps.version.outputs.RELEASE_TAG }}'
    if: |-
      ${{ github.repository == 'QwenLM/qwen-code' }}
    permissions:
      contents: 'write'
      packages: 'write'
      id-token: 'write'
      issues: 'write'
      pull-requests: 'write'
    outputs:
      RELEASE_TAG: '${{ steps.version.outputs.RELEASE_TAG }}'

    steps:
      - name: 'Checkout'
        uses: 'actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8' # ratchet:actions/checkout@v5
        with:
          ref: '${{ github.event.inputs.ref || github.sha }}'
          fetch-depth: 0

      - name: 'Set booleans for simplified logic'
        env:
          CREATE_NIGHTLY_RELEASE: '${{ github.event.inputs.create_nightly_release }}'
          CREATE_PREVIEW_RELEASE: '${{ github.event.inputs.create_preview_release }}'
          DRY_RUN_INPUT: '${{ github.event.inputs.dry_run }}'
        id: 'vars'
        run: |-
          is_nightly="false"
          if [[ "${CREATE_NIGHTLY_RELEASE}" == "true" ]]; then
            is_nightly="true"
          fi
          echo "is_nightly=${is_nightly}" >> "${GITHUB_OUTPUT}"

          is_preview="false"
          if [[ "${CREATE_PREVIEW_RELEASE}" == "true" ]]; then
            is_preview="true"
          fi
          echo "is_preview=${is_preview}" >> "${GITHUB_OUTPUT}"

          is_dry_run="false"
          if [[ "${DRY_RUN_INPUT}" == "true" ]]; then
            is_dry_run="true"
          fi
          echo "is_dry_run=${is_dry_run}" >> "${GITHUB_OUTPUT}"

      - name: 'Setup Node.js'
        uses: 'actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020' # ratchet:actions/setup-node@v4
        with:
          node-version-file: '.nvmrc'
          cache: 'npm'
          registry-url: 'https://registry.npmjs.org'
          scope: '@qwen-code'

      - name: 'Install Dependencies'
        run: |-
          npm ci

      - name: 'Get the version'
        id: 'version'
        run: |
          VERSION_ARGS=()
          if [[ "${IS_NIGHTLY}" == "true" ]]; then
            VERSION_ARGS+=(--type=nightly)
          elif [[ "${IS_PREVIEW}" == "true" ]]; then
            VERSION_ARGS+=(--type=preview)
            if [[ -n "${MANUAL_VERSION}" ]]; then
              VERSION_ARGS+=("--preview_version_override=${MANUAL_VERSION}")
            fi
          else
            VERSION_ARGS+=(--type=stable)
            if [[ -n "${MANUAL_VERSION}" ]]; then
              VERSION_ARGS+=("--stable_version_override=${MANUAL_VERSION}")
            fi
          fi

          VERSION_JSON=$(node packages/sdk-typescript/scripts/get-release-version.js "${VERSION_ARGS[@]}")
          RELEASE_TAG=$(echo "$VERSION_JSON" | jq -r .releaseTag)
          RELEASE_VERSION=$(echo "$VERSION_JSON" | jq -r .releaseVersion)
          NPM_TAG=$(echo "$VERSION_JSON" | jq -r .npmTag)
          PREVIOUS_RELEASE_TAG=$(echo "$VERSION_JSON" | jq -r .previousReleaseTag)

          # 输出到 GITHUB_OUTPUT
          echo "RELEASE_TAG=${RELEASE_TAG}" >> "$GITHUB_OUTPUT"
          echo "RELEASE_VERSION=${RELEASE_VERSION}" >> "$GITHUB_OUTPUT"
          echo "NPM_TAG=${NPM_TAG}" >> "$GITHUB_OUTPUT"
          echo "PREVIOUS_RELEASE_TAG=${PREVIOUS_RELEASE_TAG}" >> "$GITHUB_OUTPUT"

          # 打印版本信息到日志
          echo "========================================"
          echo "SDK Release Version Info"
          echo "========================================"
          echo "Release Tag:        ${RELEASE_TAG}"
          echo "Release Version:    ${RELEASE_VERSION}"
          echo "NPM Tag:            ${NPM_TAG}"
          echo "Previous Release:   ${PREVIOUS_RELEASE_TAG}"
          echo "========================================"
        env:
          GITHUB_TOKEN: '${{ secrets.GITHUB_TOKEN }}'
          IS_NIGHTLY: '${{ steps.vars.outputs.is_nightly }}'
          IS_PREVIEW: '${{ steps.vars.outputs.is_preview }}'
          MANUAL_VERSION: '${{ inputs.version }}'

      - name: 'Set SDK package version (local only)'
        env:
          RELEASE_VERSION: '${{ steps.version.outputs.RELEASE_VERSION }}'
        run: |-
          # Ensure the package version matches the computed release version.
          # This is required for nightly/preview because npm does not allow re-publishing the same version.
          npm version -w @qwen-code/sdk "${RELEASE_VERSION}" --no-git-tag-version --allow-same-version

      - name: 'Determine CLI source and version'
        id: 'cli_source'
        env:
          CLI_SOURCE_INPUT: '${{ github.event.inputs.cli_source }}'
        run: |
          # Determine CLI source mode
          if [[ "${CLI_SOURCE_INPUT}" == "npm_latest" ]]; then
            echo "mode=npm_latest" >> "$GITHUB_OUTPUT"
            echo "Building SDK with latest stable CLI from npm"
          else
            echo "mode=build_from_source" >> "$GITHUB_OUTPUT"
            echo "Building SDK with CLI built from current branch/ref"
          fi

      - name: 'Get CLI version from npm (for npm_latest mode)'
        id: 'cli_version_npm'
        if: "steps.cli_source.outputs.mode == 'npm_latest'"
        run: |
          CLI_VERSION=$(npm view @qwen-code/qwen-code version --tag=latest)
          if [[ -z "${CLI_VERSION}" ]]; then
            echo '::error::Could not get latest stable CLI version from npm'
            exit 1
          fi
          echo "CLI_VERSION=${CLI_VERSION}" >> "$GITHUB_OUTPUT"
          echo "Using latest stable CLI version from npm: ${CLI_VERSION}"

      - name: 'Download CLI package from npm'
        id: 'cli_download'
        if: "steps.cli_source.outputs.mode == 'npm_latest'"
        env:
          CLI_VERSION: '${{ steps.cli_version_npm.outputs.CLI_VERSION }}'
        run: |
          # Create temp directory for CLI package
          CLI_TMP_DIR=$(mktemp -d)
          echo "CLI_TMP_DIR=${CLI_TMP_DIR}" >> "$GITHUB_OUTPUT"

          # Download CLI package
          echo "Downloading @qwen-code/qwen-code@${CLI_VERSION}..."
          npm pack "@qwen-code/qwen-code@${CLI_VERSION}" --pack-destination "${CLI_TMP_DIR}"

          # Extract package
          cd "${CLI_TMP_DIR}"
          tar -xzf qwen-code-qwen-code-*.tgz

          echo "CLI package extracted to: ${CLI_TMP_DIR}/package"
          echo "CLI package contents:"
          ls -la "${CLI_TMP_DIR}/package/"

      - name: 'Build CLI from source'
        id: 'cli_build'
        if: "steps.cli_source.outputs.mode == 'build_from_source'"
        run: |
          # Build the CLI bundle from source
          echo "Building CLI from source..."
          npm run bundle

          # Get the CLI version from the built package
          CLI_VERSION=$(node -p "require('./packages/cli/package.json').version")
          echo "CLI_VERSION=${CLI_VERSION}" >> "$GITHUB_OUTPUT"
          echo "Built CLI version: ${CLI_VERSION}"

          # Verify dist exists
          if [[ ! -f "./dist/cli.js" ]]; then
            echo "::error::CLI bundle not found at ./dist/cli.js"
            exit 1
          fi

          echo "CLI bundle built successfully at ./dist/"
          ls -la ./dist/

      - name: 'Configure Git User'
        run: |
          git config user.name "github-actions[bot]"
          git config user.email "github-actions[bot]@users.noreply.github.com"

      - name: 'Build SDK'
        working-directory: 'packages/sdk-typescript'
        run: |-
          npm run build

      - name: 'Bundle CLI into SDK (from npm)'
        if: "steps.cli_source.outputs.mode == 'npm_latest'"
        working-directory: 'packages/sdk-typescript'
        env:
          CLI_PACKAGE_PATH: '${{ steps.cli_download.outputs.CLI_TMP_DIR }}/package'
        run: |
          node scripts/bundle-cli-from-npm.js

      - name: 'Bundle CLI into SDK (from source)'
        if: "steps.cli_source.outputs.mode == 'build_from_source'"
        working-directory: 'packages/sdk-typescript'
        run: |
          node scripts/bundle-cli.js

      - name: 'Run Tests'
        if: |-
          ${{ github.event.inputs.force_skip_tests != 'true' }}
        working-directory: 'packages/sdk-typescript'
        run: |
          npm run test:ci
        env:
          OPENAI_API_KEY: '${{ secrets.OPENAI_API_KEY }}'
          OPENAI_BASE_URL: '${{ secrets.OPENAI_BASE_URL }}'
          OPENAI_MODEL: '${{ secrets.OPENAI_MODEL }}'

      - name: 'Run SDK Integration Tests'
        if: |-
          ${{ github.event.inputs.force_skip_tests != 'true' }}
        run: |
          npm run test:integration:sdk:sandbox:none
          npm run test:integration:sdk:sandbox:docker
        env:
          OPENAI_API_KEY: '${{ secrets.OPENAI_API_KEY }}'
          OPENAI_BASE_URL: '${{ secrets.OPENAI_BASE_URL }}'
          OPENAI_MODEL: '${{ secrets.OPENAI_MODEL }}'

      - name: 'Record bundled CLI version'
        env:
          CLI_VERSION: "${{ steps.cli_source.outputs.mode == 'npm_latest' && steps.cli_version_npm.outputs.CLI_VERSION || steps.cli_build.outputs.CLI_VERSION }}"
        run: |
          # Create a metadata file to record which CLI version was bundled
          echo "${CLI_VERSION}" > packages/sdk-typescript/dist/BUNDLED_CLI_VERSION
          echo "Bundled CLI version: ${CLI_VERSION}"

      - name: 'Publish @qwen-code/sdk'
        working-directory: 'packages/sdk-typescript'
        run: |-
          npm publish --access public --tag=${{ steps.version.outputs.NPM_TAG }} ${{ steps.vars.outputs.is_dry_run == 'true' && '--dry-run' || '' }}
        env:
          NODE_AUTH_TOKEN: '${{ secrets.NPM_TOKEN }}'

      - name: 'Create and switch to a release branch'
        if: |-
          ${{ steps.vars.outputs.is_dry_run == 'false' && steps.vars.outputs.is_nightly == 'false' && steps.vars.outputs.is_preview == 'false' }}
        id: 'release_branch'
        env:
          RELEASE_TAG: '${{ steps.version.outputs.RELEASE_TAG }}'
        run: |-
          BRANCH_NAME="release/sdk-typescript/${RELEASE_TAG}"
          git switch -c "${BRANCH_NAME}"
          echo "BRANCH_NAME=${BRANCH_NAME}" >> "${GITHUB_OUTPUT}"

      - name: 'Commit and Push package version (stable only)'
        if: |-
          ${{ steps.vars.outputs.is_dry_run == 'false' && steps.vars.outputs.is_nightly == 'false' && steps.vars.outputs.is_preview == 'false' }}
        env:
          BRANCH_NAME: '${{ steps.release_branch.outputs.BRANCH_NAME }}'
          RELEASE_TAG: '${{ steps.version.outputs.RELEASE_TAG }}'
        run: |-
          # Only persist version bumps after a successful publish.
          git add packages/sdk-typescript/package.json package-lock.json
          if git diff --staged --quiet; then
            echo "No version changes to commit"
          else
            git commit -m "chore(release): sdk-typescript ${RELEASE_TAG}"
          fi
          echo "Pushing release branch to remote..."
          git push --set-upstream origin "${BRANCH_NAME}" --follow-tags

      - name: 'Create GitHub Release and Tag'
        if: |-
          ${{ steps.vars.outputs.is_dry_run == 'false' }}
        env:
          GITHUB_TOKEN: '${{ secrets.GITHUB_TOKEN }}'
          RELEASE_BRANCH: '${{ steps.release_branch.outputs.BRANCH_NAME }}'
          RELEASE_TAG: '${{ steps.version.outputs.RELEASE_TAG }}'
          PREVIOUS_RELEASE_TAG: '${{ steps.version.outputs.PREVIOUS_RELEASE_TAG }}'
          IS_NIGHTLY: '${{ steps.vars.outputs.is_nightly }}'
          IS_PREVIEW: '${{ steps.vars.outputs.is_preview }}'
          REF: '${{ github.event.inputs.ref || github.sha }}'
          CLI_VERSION: "${{ steps.cli_source.outputs.mode == 'npm_latest' && steps.cli_version_npm.outputs.CLI_VERSION || steps.cli_build.outputs.CLI_VERSION }}"
          CLI_SOURCE_MODE: '${{ steps.cli_source.outputs.mode }}'
        run: |-
          # For stable releases, use the release branch; for nightly/preview, use the current ref
          if [[ "${IS_NIGHTLY}" == "true" || "${IS_PREVIEW}" == "true" ]]; then
            TARGET="${REF}"
            PRERELEASE_FLAG="--prerelease"
          else
            TARGET="${RELEASE_BRANCH}"
            PRERELEASE_FLAG=""
          fi

          # Determine CLI source description
          if [[ "${CLI_SOURCE_MODE}" == "npm_latest" ]]; then
            CLI_SOURCE_DESC="latest stable CLI from npm"
          else
            CLI_SOURCE_DESC="CLI built from source (same branch/ref as SDK)"
          fi

          # Create release notes with CLI version info
          NOTES="## Bundled CLI Version\n\nThis SDK release bundles CLI version: \`${CLI_VERSION}\`\n\nSource: ${CLI_SOURCE_DESC}\n\n---\n\n"

          gh release create "sdk-typescript-${RELEASE_TAG}" \
            --target "${TARGET}" \
            --title "SDK TypeScript Release ${RELEASE_TAG}" \
            --notes-start-tag "sdk-typescript-${PREVIOUS_RELEASE_TAG}" \
            --notes "${NOTES}$(gh release view "sdk-typescript-${PREVIOUS_RELEASE_TAG}" --json body -q '.body' 2>/dev/null || echo 'See commit history for changes.')" \
            "${PRERELEASE_FLAG}"

      - name: 'Create PR to merge release branch into main'
        if: |-
          ${{ steps.vars.outputs.is_dry_run == 'false' && steps.vars.outputs.is_nightly == 'false' && steps.vars.outputs.is_preview == 'false' }}
        id: 'pr'
        env:
          GITHUB_TOKEN: '${{ secrets.CI_BOT_PAT }}'
          RELEASE_BRANCH: '${{ steps.release_branch.outputs.BRANCH_NAME }}'
          RELEASE_TAG: '${{ steps.version.outputs.RELEASE_TAG }}'
        run: |-
          set -euo pipefail

          pr_url="$(gh pr list --head "${RELEASE_BRANCH}" --base main --json url --jq '.[0].url')"
          if [[ -z "${pr_url}" ]]; then
            pr_url="$(gh pr create \
              --base main \
              --head "${RELEASE_BRANCH}" \
              --title "chore(release): sdk-typescript ${RELEASE_TAG}" \
              --body "Automated release PR for sdk-typescript ${RELEASE_TAG}.")"
          fi

          echo "PR_URL=${pr_url}" >> "${GITHUB_OUTPUT}"

      - name: 'Enable auto-merge for release PR'
        if: |-
          ${{ steps.vars.outputs.is_dry_run == 'false' && steps.vars.outputs.is_nightly == 'false' && steps.vars.outputs.is_preview == 'false' }}
        env:
          GITHUB_TOKEN: '${{ secrets.CI_BOT_PAT }}'
          PR_URL: '${{ steps.pr.outputs.PR_URL }}'
        run: |-
          set -euo pipefail
          gh pr merge "${PR_URL}" --merge --auto --delete-branch

      - name: 'Create Issue on Failure'
        if: |-
          ${{ failure() && steps.vars.outputs.is_dry_run == 'false' }}
        env:
          GITHUB_TOKEN: '${{ secrets.GITHUB_TOKEN }}'
          RELEASE_TAG: "${{ steps.version.outputs.RELEASE_TAG || 'N/A' }}"
          DETAILS_URL: '${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}'
        run: |-
          gh issue create \
            --title "SDK Release Failed for ${RELEASE_TAG} on $(date +'%Y-%m-%d')" \
            --body "The SDK release workflow failed. See the full run for details: ${DETAILS_URL}"