sdk-dotnet.yml

# Invoked by sdk.yml to run the .NET SDK build/test matrix, documentation,
# full subprocess CAPI coverage, and focused in-process smoke
# coverage across standard platforms and x64 musl.
name: "SDK .NET"

env:
  HUSKY: 0
  POWERSHELL_UPDATECHECK: Off
  SDK_HOME: ${{ inputs.sdk-home }}
  SETUP_NODE_TIMEOUT_MINUTES: 10

on:
  workflow_call:
    inputs:
      platform:
        required: false
        type: string
        default: all
      sdk-home:
        required: true
        type: string

permissions:
  contents: read

jobs:
  dotnet-linux-x64:
    name: ".NET (ubuntu-latest, CAPI)"
    if: inputs.platform == 'all' || inputs.platform == 'linux-x64'
    timeout-minutes: 30
    runs-on: ubuntu-latest
    defaults:
      run:
        shell: bash
        working-directory: ${{ inputs.sdk-home }}/dotnet
    env:
      COPILOT_SDK_E2E_BACKEND: capi
      DOTNET_TEST_RESULTS_DIRECTORY: TestResults/subprocess
    steps:
      - uses: actions/checkout@v7
        timeout-minutes: 4
        with:
          persist-credentials: false
      - uses: ./.github/actions/download-sdk-runtime
        with:
          artifact-name: executable-sdk-Linux-X64-gnu
          path: ${{ github.workspace }}
      - run: node "$SDK_HOME/scripts/ci/runtime-artifact.mjs" restore && node "$SDK_HOME/scripts/ci/runtime-artifact.mjs" prepare
        working-directory: .
      - uses: actions/setup-dotnet@v6
        with:
          dotnet-version: "10.0.x"
      - uses: actions/setup-node@v6
        with:
          node-version: 22
      - run: dotnet restore -p:CopilotCliBinaryPath="$COPILOT_RUNTIME_BINARY_PATH" -p:CopilotSkipCliDownload=true
      # TEMPORARY MERGE QUEUE REDUCTION: pull requests and main pushes retain
      # static checks; merge groups rerun only SDK compatibility coverage.
      - if: github.event_name != 'merge_group'
        run: dotnet format --verify-no-changes --no-restore
      - run: dotnet build --no-restore -p:CopilotCliBinaryPath="$COPILOT_RUNTIME_BINARY_PATH" -p:CopilotSkipCliDownload=true
      - name: Test structured output with reflection enabled
        env:
          DOTNET_ROLL_FORWARD: Major
        run: >-
          dotnet test test/GitHub.Copilot.SDK.Test.csproj --no-restore --framework net8.0
          -p:JsonSerializerIsReflectionEnabledByDefault=true
          -p:CopilotCliBinaryPath="$COPILOT_RUNTIME_BINARY_PATH"
          -p:CopilotSkipCliDownload=true
          --filter "FullyQualifiedName~GitHub.Copilot.Test.Unit.ClientSessionLifetimeTests.StructuredOutput"
      - run: npm ci --ignore-scripts
        working-directory: ${{ inputs.sdk-home }}/test/harness
      - name: Test out-of-process
        id: subprocess
        env:
          COPILOT_HMAC_KEY: ${{ secrets.COPILOT_DEVELOPER_CLI_INTEGRATION_HMAC_KEY }}
        run: ../scripts/ci/run-dotnet-tests.sh
      - name: Test in-process smoke
        if: ${{ !cancelled() && (steps.subprocess.outcome == 'success' || steps.subprocess.outcome == 'failure') }}
        env:
          COPILOT_HMAC_KEY: ${{ secrets.COPILOT_DEVELOPER_CLI_INTEGRATION_HMAC_KEY }}
          COPILOT_SDK_DEFAULT_CONNECTION: inprocess
          DOTNET_TEST_RESULTS_DIRECTORY: TestResults/inprocess
          DOTNET_TEST_FILTER: "FullyQualifiedName~GitHub.Copilot.Test.E2E.ClientE2ETests.Should_Start_And_Connect_Over_InProcess_Ffi|FullyQualifiedName~GitHub.Copilot.Test.E2E.SessionE2ETests.Should_Receive_Session_Events|FullyQualifiedName~GitHub.Copilot.Test.E2E.ClientOptionsE2ETests.Should_Use_Configured_GitHub_Host_For_Authentication"
        run: ../scripts/ci/run-dotnet-tests.sh
      - name: Validate documentation examples
        if: github.event_name != 'merge_group'
        working-directory: ${{ inputs.sdk-home }}/scripts/docs-validation
        run: |
          npm ci
          npm run extract
          npm run validate:cs
      - if: failure()
        uses: actions/upload-artifact@v7
        with:
          name: dotnet-test-diagnostics-ubuntu-latest-capi-${{ github.run_attempt }}
          path: ${{ inputs.sdk-home }}/dotnet/TestResults/
          if-no-files-found: warn
          retention-days: 7

  dotnet-darwin-arm64:
    name: ".NET (macos-latest, default, CAPI)"
    if: inputs.platform == 'all' || inputs.platform == 'darwin-arm64'
    runs-on: macos-latest
    timeout-minutes: 30
    defaults:
      run:
        shell: bash
        working-directory: ${{ inputs.sdk-home }}/dotnet
    env:
      COPILOT_SDK_E2E_BACKEND: capi
      DOTNET_TEST_RESULTS_DIRECTORY: TestResults/subprocess
    steps:
      - uses: actions/checkout@v7
        timeout-minutes: 4
        with:
          persist-credentials: false
      - uses: ./.github/actions/download-sdk-runtime
        with:
          artifact-name: executable-sdk-macOS-ARM64
          path: ${{ github.workspace }}
      - run: node "$SDK_HOME/scripts/ci/runtime-artifact.mjs" restore && node "$SDK_HOME/scripts/ci/runtime-artifact.mjs" prepare
        working-directory: .
      - uses: actions/setup-dotnet@v6
        with:
          dotnet-version: "10.0.x"
      - uses: actions/setup-node@v6
        with:
          node-version: 22
      - run: dotnet restore -p:CopilotCliBinaryPath="$COPILOT_RUNTIME_BINARY_PATH" -p:CopilotSkipCliDownload=true
      - run: dotnet build --no-restore -p:CopilotCliBinaryPath="$COPILOT_RUNTIME_BINARY_PATH" -p:CopilotSkipCliDownload=true
      - run: npm ci --ignore-scripts
        working-directory: ${{ inputs.sdk-home }}/test/harness
      - name: Test out-of-process
        id: subprocess
        env:
          COPILOT_HMAC_KEY: ${{ secrets.COPILOT_DEVELOPER_CLI_INTEGRATION_HMAC_KEY }}
        run: ../scripts/ci/run-dotnet-tests.sh
      - name: Test in-process smoke
        if: ${{ !cancelled() && (steps.subprocess.outcome == 'success' || steps.subprocess.outcome == 'failure') }}
        env:
          COPILOT_HMAC_KEY: ${{ secrets.COPILOT_DEVELOPER_CLI_INTEGRATION_HMAC_KEY }}
          COPILOT_SDK_DEFAULT_CONNECTION: inprocess
          DOTNET_TEST_RESULTS_DIRECTORY: TestResults/inprocess
          DOTNET_TEST_FILTER: "FullyQualifiedName~GitHub.Copilot.Test.E2E.ClientE2ETests.Should_Start_And_Connect_Over_InProcess_Ffi|FullyQualifiedName~GitHub.Copilot.Test.E2E.SessionE2ETests.Should_Receive_Session_Events|FullyQualifiedName~GitHub.Copilot.Test.E2E.ClientOptionsE2ETests.Should_Use_Configured_GitHub_Host_For_Authentication"
        run: ../scripts/ci/run-dotnet-tests.sh
      - if: failure()
        uses: actions/upload-artifact@v7
        with:
          name: dotnet-test-diagnostics-macos-latest-default-capi-${{ github.run_attempt }}
          path: ${{ inputs.sdk-home }}/dotnet/TestResults/
          if-no-files-found: warn
          retention-days: 7

  dotnet-win32-x64:
    name: ".NET (windows-latest, default, CAPI)"
    if: inputs.platform == 'all' || inputs.platform == 'win32-x64'
    runs-on: windows-latest
    timeout-minutes: 30
    defaults:
      run:
        shell: bash
        working-directory: ${{ inputs.sdk-home }}/dotnet
    env:
      COPILOT_SDK_E2E_BACKEND: capi
      DOTNET_TEST_RUNTIME: win-x64
      DOTNET_TEST_RESULTS_DIRECTORY: TestResults/subprocess
    steps:
      - uses: actions/checkout@v7
        timeout-minutes: 4
        with:
          persist-credentials: false
      - uses: ./.github/actions/download-sdk-runtime
        with:
          artifact-name: executable-sdk-Windows-X64
          path: ${{ github.workspace }}
      - run: node "$SDK_HOME/scripts/ci/runtime-artifact.mjs" restore && node "$SDK_HOME/scripts/ci/runtime-artifact.mjs" prepare
        working-directory: .
      - uses: actions/setup-dotnet@v6
        with:
          dotnet-version: "10.0.x"
      - uses: actions/setup-node@v6
        with:
          node-version: 22
      - run: dotnet restore test/GitHub.Copilot.SDK.Test.csproj --runtime "$DOTNET_TEST_RUNTIME" -p:CopilotCliBinaryPath="$COPILOT_RUNTIME_BINARY_PATH" -p:CopilotSkipCliDownload=true
      - run: dotnet build test/GitHub.Copilot.SDK.Test.csproj --no-restore --runtime "$DOTNET_TEST_RUNTIME" -p:CopilotCliBinaryPath="$COPILOT_RUNTIME_BINARY_PATH" -p:CopilotSkipCliDownload=true
      - run: npm ci --ignore-scripts
        working-directory: ${{ inputs.sdk-home }}/test/harness
      - run: pwsh.exe -Command "Write-Host 'PowerShell ready'"
      - name: Test out-of-process
        id: subprocess
        env:
          COPILOT_HMAC_KEY: ${{ secrets.COPILOT_DEVELOPER_CLI_INTEGRATION_HMAC_KEY }}
        run: ../scripts/ci/run-dotnet-tests.sh
      - name: Test in-process smoke
        if: ${{ !cancelled() && (steps.subprocess.outcome == 'success' || steps.subprocess.outcome == 'failure') }}
        env:
          COPILOT_HMAC_KEY: ${{ secrets.COPILOT_DEVELOPER_CLI_INTEGRATION_HMAC_KEY }}
          COPILOT_SDK_DEFAULT_CONNECTION: inprocess
          DOTNET_TEST_RESULTS_DIRECTORY: TestResults/inprocess
          DOTNET_TEST_FILTER: "FullyQualifiedName~GitHub.Copilot.Test.E2E.ClientE2ETests.Should_Start_And_Connect_Over_InProcess_Ffi|FullyQualifiedName~GitHub.Copilot.Test.E2E.SessionE2ETests.Should_Receive_Session_Events|FullyQualifiedName~GitHub.Copilot.Test.E2E.ClientOptionsE2ETests.Should_Use_Configured_GitHub_Host_For_Authentication"
        run: ../scripts/ci/run-dotnet-tests.sh
      - if: failure()
        uses: actions/upload-artifact@v7
        with:
          name: dotnet-test-diagnostics-windows-latest-default-capi-${{ github.run_attempt }}
          path: ${{ inputs.sdk-home }}/dotnet/TestResults/
          if-no-files-found: warn
          retention-days: 7

  dotnet-musl-x64:
    name: ".NET (Alpine x64, CAPI)"
    if: inputs.platform == 'all' || inputs.platform == 'linuxmusl-x64'
    runs-on: ubuntu-latest
    timeout-minutes: 20
    env:
      COPILOT_SDK_E2E_BACKEND: capi
    steps:
      - uses: actions/checkout@v7
        timeout-minutes: 4
        with:
          persist-credentials: false
      - uses: ./.github/actions/download-sdk-runtime
        with:
          artifact-name: executable-sdk-Linux-X64-musl
          path: ${{ github.workspace }}
      - run: node "$SDK_HOME/scripts/ci/runtime-artifact.mjs" restore
        working-directory: .
      - uses: ./.github/actions/run-alpine-tests
        env:
          COPILOT_HMAC_KEY: ${{ secrets.COPILOT_DEVELOPER_CLI_INTEGRATION_HMAC_KEY }}
          COPILOT_SDK_E2E_BACKEND: capi
        with:
          image: mcr.microsoft.com/dotnet/sdk:10.0-alpine
          sdk-root: /workspace/${{ inputs.sdk-home }}
          workdir: /workspace/${{ inputs.sdk-home }}
          command: |
            dotnet --info | grep -Eq "RID:[[:space:]]+linux-musl-x64"
            apk add --no-cache nodejs npm
            npm --prefix "$COPILOT_SDK_ROOT/nodejs" ci --ignore-scripts
            npm --prefix "$COPILOT_SDK_ROOT/test/harness" ci --ignore-scripts

            export GITHUB_ENV=/tmp/copilot-sdk-runtime.env
            export COPILOT_RUNTIME_TARGET=linuxmusl-x64
            export COPILOT_RUNTIME_OUTPUT_DIRECTORY=/workspace/.sdk-runtime/linuxmusl-x64
            node "$COPILOT_SDK_ROOT/scripts/ci/runtime-artifact.mjs" prepare
            set -a
            . "$GITHUB_ENV"
            set +a
            case "$COPILOT_CLI_PATH" in
              */prebuilds/linuxmusl-x64/copilot-runtime) ;;
              *) echo "Expected the linuxmusl-x64 runtime, got: $COPILOT_CLI_PATH" >&2; exit 1 ;;
            esac

            export DOTNET_ROLL_FORWARD=Major
            dotnet restore "$COPILOT_SDK_ROOT/dotnet/test/GitHub.Copilot.SDK.Test.csproj" \
              -p:CopilotCliBinaryPath="$COPILOT_RUNTIME_BINARY_PATH" \
              -p:CopilotSkipCliDownload=true
            dotnet build "$COPILOT_SDK_ROOT/dotnet/test/GitHub.Copilot.SDK.Test.csproj" \
              --no-restore --framework net8.0 \
              -p:CopilotCliBinaryPath="$COPILOT_RUNTIME_BINARY_PATH" \
              -p:CopilotSkipCliDownload=true \
              -p:RunAnalyzers=false
            set -- "$COPILOT_SDK_ROOT/dotnet/test/GitHub.Copilot.SDK.Test.csproj" \
              --no-build \
              --framework net8.0 \
              -v n \
              --blame-hang \
              --blame-hang-timeout 10m \
              --blame-hang-dump-type none \
              --logger "trx;LogFilePrefix=test-results" \
              -p:CopilotCliBinaryPath="$COPILOT_RUNTIME_BINARY_PATH" \
              -p:CopilotSkipCliDownload=true \
              -p:RunAnalyzers=false
            status=0
            dotnet test "$@" --results-directory "$COPILOT_SDK_ROOT/dotnet/TestResults/subprocess" || status=$?
            COPILOT_SDK_DEFAULT_CONNECTION=inprocess dotnet test "$@" \
              --results-directory "$COPILOT_SDK_ROOT/dotnet/TestResults/inprocess" \
              --filter 'FullyQualifiedName~GitHub.Copilot.Test.E2E.ClientE2ETests.Should_Start_And_Connect_Over_InProcess_Ffi|FullyQualifiedName~GitHub.Copilot.Test.E2E.SessionE2ETests.Should_Receive_Session_Events|FullyQualifiedName~GitHub.Copilot.Test.E2E.ClientOptionsE2ETests.Should_Use_Configured_GitHub_Host_For_Authentication' || status=$?
            exit "$status"
      - name: Upload .NET test diagnostics
        if: failure()
        uses: actions/upload-artifact@v7
        with:
          name: dotnet-test-diagnostics-alpine-x64-capi-${{ github.run_attempt }}
          path: ${{ inputs.sdk-home }}/dotnet/TestResults/
          if-no-files-found: warn
          retention-days: 7