feat: add Windows support for 1Password CLI for GH runners

marcelotrevisani · sszzsolt · marcelotrevisani · commit bd942651eb07 · 2025-02-12T09:56:35.000Z
Co-authored-by: sszzsolt &lt;sszzsolt@users.noreply.github.com&gt;
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -6,19 +6,24 @@ jobs:
     name: "Test getting latest CLI stable version"
     strategy:
       matrix:
-        os: [ubuntu-latest, macos-latest]
+        os: [ubuntu-latest, macos-latest, windows-latest]
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v3
       - name: Install 1Password CLI
         uses: ./ # 1password/install-cli-action@<version>
       - name: Check CLI version
+        if: matrix.os == 'ubuntu-latest' || matrix.os == 'macos-latest'
         run: ./test/assert-version.sh latest
+      - name: Check CLI version
+        if: matrix.os == 'windows-latest'
+        run: .\test\assert-version.ps1 latest
+        shell: pwsh
   use-latest-beta-version:
     name: "Test getting latest CLI beta version"
     strategy:
       matrix:
-        os: [ubuntu-latest, macos-latest]
+        os: [ubuntu-latest, macos-latest, windows-latest]
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v3
@@ -27,12 +32,17 @@ jobs:
         with:
           version: latest-beta
       - name: Check CLI version
+        if: matrix.os == 'ubuntu-latest' || matrix.os == 'macos-latest'
         run: ./test/assert-version.sh latest-beta
+      - name: Check CLI version
+        if: matrix.os == 'windows-latest'
+        run: .\test\assert-version.ps1 latest-beta
+        shell: pwsh
   use-specific-version:
     name: "Test getting a specific CLI version"
     strategy:
       matrix:
-        os: [ubuntu-latest, macos-latest]
+        os: [ubuntu-latest, macos-latest, windows-latest]
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v3
@@ -41,12 +51,17 @@ jobs:
         with:
           version: 2.18.0
       - name: Check CLI version
+        if: matrix.os == 'ubuntu-latest' || matrix.os == 'macos-latest'
         run: ./test/assert-version.sh 2.18.0
+      - name: Check CLI version
+        if: matrix.os == 'windows-latest'
+        run: .\test\assert-version.ps1 2.18.0
+        shell: pwsh
   use-specific-beta-version:
     name: "Test getting a specific CLI beta version"
     strategy:
       matrix:
-        os: [ubuntu-latest, macos-latest]
+        os: [ubuntu-latest, macos-latest, windows-latest]
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v3
@@ -55,4 +70,9 @@ jobs:
         with:
           version: 2.19.0-beta.01
       - name: Check CLI version
+        if: matrix.os == 'ubuntu-latest' || matrix.os == 'macos-latest'
         run: ./test/assert-version.sh 2.19.0-beta.01
+      - name: Check CLI version
+        if: matrix.os == 'windows-latest'
+        run: .\test\assert-version.ps1 2.19.0-beta.01
+        shell: pwsh
diff --git a/README.md b/README.md
@@ -41,7 +41,7 @@ To install a specific version of the 1Password CLI:
 
 ## ⚙️ Supported Runners
 
-You can perform the action on Linux and macOS runners. Windows is not currently supported.
+You can perform the action on Linux, macOS and Windows runners.
 
 ## 💙 Community & Support
 
@@ -53,4 +53,6 @@ You can perform the action on Linux and macOS runners. Windows is not currently
 
 1Password requests you practice responsible disclosure if you discover a vulnerability.
 
-Please file requests by sending an email to bugbounty@agilebits.com.
+Please file requests via [**BugCrowd**](https://bugcrowd.com/agilebits).
+
+For information about security practices, please visit our [Security homepage](https://bugcrowd.com/agilebits).
diff --git a/action.yml b/action.yml
@@ -12,7 +12,14 @@ runs:
   using: composite
   steps:
     - shell: bash
+      if: ${{ runner.os == 'Linux' || runner.os == 'macOS' }}
       env:
         OP_CLI_VERSION: ${{ inputs.version }}
       run: |
         ${{ github.action_path }}/install-cli.sh
+    - shell: pwsh
+      if: ${{ runner.os == 'Windows' }}
+      env:
+        OP_CLI_VERSION: ${{ inputs.version }}
+      run: |
+        ${{ github.action_path }}\install-cli.ps1
diff --git a/install-cli.ps1 b/install-cli.ps1
@@ -0,0 +1,94 @@
+$CLI_URL = "https://app-updates.agilebits.com/product_history/CLI2"
+
+# Fetch the latest version of 1Password CLI (Stable or Beta)
+function Get-LatestCLIVersion {
+    param(
+        [ValidateSet("beta", "non_beta")]
+        [string]$VersionType
+    )
+
+    try {
+        $html = Invoke-WebRequest -Uri $CLI_URL -UseBasicParsing
+
+        $versions = $html.Content |
+            Select-String -Pattern '(?ms)<h3>(.*?)<\/h3>' -AllMatches |
+                ForEach-Object { $_.Matches.Groups[1].Value -replace '\s+', '' -replace '<span.*?>|<\/span>|&nbsp;.*', '' }
+
+        # Find the correct version based on the type requested
+        $latestVersion = $versions | Where-Object { $VersionType -eq "beta" -or ($_ -notmatch "beta") } | Select-Object -First 1
+
+        if (-not $latestVersion) {
+            Write-Error "No suitable version found for type: $VersionType" -ErrorAction Stop
+        }
+
+        return "v$latestVersion"
+    } catch {
+        Write-Error "Failed to fetch latest version: $_"
+        exit 1
+    }
+}
+
+# Install 1Password CLI
+function Install-OPCLI {
+    param(
+        [string]$OP_CLI_VERSION
+    )
+
+    Write-Host "Installing 1Password CLI version: $OP_CLI_VERSION"
+
+    if ($IsWindows) {
+        # Get system architecture
+        try {
+            $WIN32_ARCH = (Get-CimInstance Win32_OperatingSystem).OSArchitecture
+        } catch {
+            Write-Error "Failed to detect OS architecture: $_"
+            exit 1
+        }
+
+        switch ($WIN32_ARCH) {
+            '64-bit' { $ARCH = 'amd64' }
+            '32-bit' { $ARCH = '386' }
+            Default { Write-Error "Unsupported OS architecture: '$WIN32_ARCH'"; exit 1 }
+        }
+
+        $DownloadUrl = "https://cache.agilebits.com/dist/1P/op2/pkg/$OP_CLI_VERSION/op_windows_${ARCH}_$OP_CLI_VERSION.zip"
+        $InstallDir = Join-Path -Path $env:ProgramFiles -ChildPath '1Password CLI'
+
+        try {
+            Invoke-WebRequest -Uri $DownloadUrl -OutFile op.zip
+            Expand-Archive -Path op.zip -DestinationPath $InstallDir -Force
+            Remove-Item -Path op.zip -Force
+        } catch {
+            Write-Error "Failed to install 1Password CLI: $_"
+            exit 1
+        }
+
+        # Add install path to system environment variables
+        $EnvMachinePath = [System.Environment]::GetEnvironmentVariable('PATH', 'Machine')
+        if ($EnvMachinePath -split ';' -notcontains $InstallDir) {
+            [Environment]::SetEnvironmentVariable('PATH', "$EnvMachinePath;$InstallDir", 'Machine')
+        }
+
+        Write-Output $InstallDir | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append
+        Write-Host "Installation completed successfully!"
+    } else {
+        Write-Error "This PowerShell script does not support non-Windows installations."
+        exit 1
+    }
+}
+
+# Main script execution
+try {
+    if ($env:OP_CLI_VERSION -eq "latest") {
+        $OP_CLI_VERSION = Get-LatestCLIVersion -VersionType "non_beta"
+    } elseif ($env:OP_CLI_VERSION -eq "latest-beta") {
+        $OP_CLI_VERSION = Get-LatestCLIVersion -VersionType "beta"
+    } else {
+        $OP_CLI_VERSION = "v$env:OP_CLI_VERSION"
+    }
+
+    Install-OPCLI -OP_CLI_VERSION $OP_CLI_VERSION
+} catch {
+    Write-Error "Unexpected error occurred: $_"
+    exit 1
+}
diff --git a/test/assert-version.ps1 b/test/assert-version.ps1
@@ -0,0 +1,51 @@
+$OP_CLI_VERSION = $args[0]
+$CLI_URL = "https://app-updates.agilebits.com/product_history/CLI2"
+
+# Function to fetch the latest 1Password CLI version
+function Get-LatestCLIVersion {
+    param(
+        [ValidateSet("beta", "non_beta")]
+        [string]$VersionType
+    )
+
+    try {
+        $html = Invoke-WebRequest -Uri $CLI_URL -UseBasicParsing
+
+        $versions = $html.Content |
+            Select-String -Pattern '(?ms)<h3>(.*?)<\/h3>' -AllMatches |
+                ForEach-Object { $_.Matches.Groups[1].Value -replace '\s+', '' -replace '<span.*?>|<\/span>|&nbsp;.*', '' }
+
+        # Find the latest version based on the requested type
+        $latestVersion = $versions | Where-Object { $VersionType -eq "beta" -or ($_ -notmatch "beta") } | Select-Object -First 1
+
+        if (-not $latestVersion) {
+            Write-Error "No suitable version found for type: $VersionType" -ErrorAction Stop
+        }
+
+        return $latestVersion
+    } catch {
+        Write-Error "Failed to fetch latest version: $_"
+        exit 1
+    }
+}
+
+# Determine the desired 1Password CLI version
+if ($OP_CLI_VERSION -eq "latest") {
+    $OP_CLI_VERSION = Get-LatestCLIVersion -VersionType "non_beta"
+} elseif ($OP_CLI_VERSION -eq "latest-beta") {
+    $OP_CLI_VERSION = Get-LatestCLIVersion -VersionType "beta"
+}
+
+# Check if 1Password CLI is installed before running the version check
+if (-Not (Get-Command op -ErrorAction SilentlyContinue)) {
+    Write-Error "1Password CLI ('op') is not installed or not found in PATH."
+    exit 1
+}
+
+# Compare the installed version with the expected version
+$installedVersion = op --version
+if ($installedVersion -ne $OP_CLI_VERSION) {
+    Write-Output "Expected CLI version: $OP_CLI_VERSION"
+    Write-Output "But found installed version: $installedVersion"
+    exit 1
+}
