action.yml

name: Install Cygwin Action
description: GitHub Action to install Cygwin

inputs:
  platform:
    description: Platform [x86, x86_64]
    required: false
    default: x86_64
  packages:
    description: Packages to install
    required: false
  install-dir:
    # For consistency and simplicity, install to <work-dir>:\cygwin rather
    # than to the platform dependent default (e.g. <work-dir>:\cygwin64)
    description: Installation directory (overrides work-vol)
    required: false
    default: ''
  check-sig:
    description: Should the setup.ini file signature be checked?
    required: false
    default: 'true'
  pubkeys:
    description: Absolute paths of extra public key files (RFC4880 format), separated by whitespace
    required: false
  site:
    description: Download site URLs separated by whitespace
    required: false
  add-to-path:
    description: Should Cygwin's bin directory be added to the system PATH?
    required: false
    default: 'true'
  allow-test-packages:
    description: Consider package versions marked test
    required: false
    default: 'false'
  check-hash:
    description: Check the hash of the installer
    required: false
    default: 'true'
  work-vol:
    description: Volume on which to store setup and packages, and install Cygwin
    required: false
    default: ''

runs:
  using: "composite"
  steps:
    - run: |
        $ErrorActionPreference = 'Stop'
        $platform = '${{ inputs.platform }}'
        $platform = $platform -replace '^(x64|amd64)$', 'x86_64'
        $platform = $platform -replace '^i686$', 'x86'
        # validate that platform is one of the expected values
        if (($platform -ne 'x86') -and ($platform -ne 'x86_64')) {
          echo "unknown platform $platform"
          exit 1
        }

        $vol = '${{ inputs.work-vol }}'
        # If temporary drive D: doesn't exist in the VM, fallback to C:
        if ("$vol" -eq '') {
          $vol = (Test-Path -LiteralPath 'D:\') ? 'D:' : 'C:'
        }

        $setupExe = "$vol\setup.exe"
        $setupFileName = "setup-$platform.exe"
        Invoke-WebRequest "https://cygwin.com/$setupFileName" -OutFile $setupExe
        if ((Get-Item -LiteralPath $setupExe).Length -eq 0) {
          throw "The downloaded setup has a zero length!"
        }

        if ('${{ inputs.check-hash }}' -eq 'true') {
          $expectedHashLines = $(Invoke-WebRequest -Uri https://cygwin.com/sha512.sum).ToString() -split "`n"
          $expectedHash = ''
          foreach ($expectedHashLine in $expectedHashLines) {
            if ($expectedHashLine.EndsWith(" $setupFileName")) {
              $expectedHash = $($expectedHashLine -split '\s+')[0]
              break
            }
          }
          if ($expectedHash -eq '') {
            Write-Output -InputObject "::warning::Unable to find the hash for the file $setupFileName in https://cygwin.com/sha512.sum"
          } else {
            $actualHash = $(Get-FileHash -LiteralPath $setupExe -Algorithm SHA512).Hash
            if ($actualHash -ine $expectedHash) {
              throw "Invalid hash of the downloaded setup!`nExpected: $expectedHash`nActual  : $actualHash"
            } else {
              Write-Output -InputObject "The downloaded file has the expected hash ($expectedHash)"
            }
          }
        }

        $installDir = '${{ inputs.install-dir }}' -ne '' ? '${{ inputs.install-dir }}' : "$vol\cygwin"

        $args = @(
         '-qnO',
         '-l', "$vol\cygwin-packages",
         '-R', "$installDir"
        )

        if ( '${{ inputs.allow-test-packages }}' -eq 'true' ) {
          $args += '-t' # --allow-test-packages
        }

        # default site if not specified
        if ( '${{ inputs.site }}' ) {
          $sites = '${{ inputs.site }}'
        } elseif ($platform -eq 'x86') {
          $sites = 'http://mirrors.kernel.org/sourceware/cygwin-archive/20221123'
        } else {
          $sites = 'http://mirrors.kernel.org/sourceware/cygwin/'
        }
        $site_list = $sites -split '[\s,]+',0,"RegexMatch,Singleline" | Where { $_ -ne '' }
        foreach ($site in $site_list) {
          $args += '-s'
          $args += $site
        }

        $pkg_list = '${{ inputs.packages }}' -split '[\s,]+',0,"RegexMatch,Singleline" | Where { $_ -ne '' }
        if ($pkg_list.Count -gt 0) {
          $args += '-P'
          $args += $pkg_list -Join(',')
        }

        if ('${{ inputs.check-sig }}' -eq $false) {
          $args += '-X'
        }

        $pubkey_list = '${{inputs.pubkeys}}' -split '[\s,]+',0,"RegexMatch,Singleline" | Where { $_ -ne '' }
        foreach ($pubkey in $pubkey_list) {
          $args += '-K'
          $args += $pubkey
        }

        if ($platform -eq 'x86') {
          $args += '--allow-unsupported-windows'
        }

        # because setup is a Windows GUI app, make it part of a pipeline to make
        # PowerShell wait for it to exit
        & $setupExe $args | Out-Default

        if ('${{ inputs.work-vol }}' -eq '' -and '${{ inputs.install-dir }}' -eq '') {
          # Create a symlink for compatibility with previous versions of this
          # action, just in case something relies upon C:\cygwin existing
          cmd /c mklink /d C:\cygwin $installDir
        }

        if ('${{ inputs.add-to-path }}' -eq 'true') {
          echo "$installDir\bin" >> $env:GITHUB_PATH
        }

        # run login shell to copy skeleton profile files
        & "$installDir\bin\bash.exe" --login
      shell: pwsh

branding:
  color: green
  icon: terminal