chore(p2): add winget/choco/scoop distribution templates (#44)

Kinin-Code-Offical · web-flow · commit 3a142f6f61d1 · 2025-12-22T06:06:05.000+03:00
diff --git a/README.md b/README.md
@@ -15,17 +15,23 @@
 
 ## Installation
 
-Download the latest installer (`cloudsqlctl-setup.exe`) from the [Releases](https://github.com/Kinin-Code-Offical/cloudsqlctl/releases) page.
+Primary distribution is via GitHub Releases:
+- Download the latest installer (`cloudsqlctl-setup.exe`) from the [Releases](https://github.com/Kinin-Code-Offical/cloudsqlctl/releases) page.
+
+Optional/community distribution:
+- Scoop: see `scoop/README.md`
+- Winget/Chocolatey: see `docs/Distribution.md`
 
 ## Documentation
 
 Full documentation is available in the [docs](docs/) folder:
 
 - [**Wiki Home**](docs/Home.md)
 - [Installation Guide](docs/Installation.md)
-- [Configuration & Setup](docs/Configuration.md)
-- [Command Reference](docs/commands.md)
-- [Troubleshooting](docs/Troubleshooting.md)
+  - [Configuration & Setup](docs/Configuration.md)
+  - [Command Reference](docs/commands.md)
+  - [Distribution](docs/Distribution.md)
+  - [Troubleshooting](docs/Troubleshooting.md)
 
 ## Quick Start
 
diff --git a/chocolatey/cloudsqlctl/cloudsqlctl.nuspec b/chocolatey/cloudsqlctl/cloudsqlctl.nuspec
@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="utf-8"?>
+<package xmlns="http://schemas.microsoft.com/packaging/2015/06/nuspec.xsd">
+  <metadata>
+    <id>cloudsqlctl</id>
+    <version>0.4.15</version>
+    <title>CloudSQLCTL</title>
+    <authors>Kinin-Code-Offical</authors>
+    <owners>Kinin-Code-Offical</owners>
+    <license type="expression">MIT</license>
+    <projectUrl>https://github.com/Kinin-Code-Offical/cloudsqlctl</projectUrl>
+    <requireLicenseAcceptance>false</requireLicenseAcceptance>
+    <description>Windows-native CLI to install, update, and manage Google Cloud SQL Auth Proxy via gcloud.</description>
+    <tags>windows cli gcloud cloud-sql</tags>
+  </metadata>
+  <files>
+    <file src="tools\**" target="tools" />
+  </files>
+</package>
+
+
diff --git a/chocolatey/cloudsqlctl/tools/VERIFICATION.txt b/chocolatey/cloudsqlctl/tools/VERIFICATION.txt
@@ -0,0 +1,10 @@
+VERIFICATION
+============
+
+This package downloads the release zip from:
+https://github.com/Kinin-Code-Offical/cloudsqlctl/releases
+
+To verify contents:
+1) Download the matching `SHA256SUMS.txt` for the release tag.
+2) Confirm the zip hash matches the entry for `cloudsqlctl-windows-x64.zip`.
+
diff --git a/chocolatey/cloudsqlctl/tools/chocolateyInstall.ps1 b/chocolatey/cloudsqlctl/tools/chocolateyInstall.ps1
@@ -0,0 +1,16 @@
+$ErrorActionPreference = 'Stop'
+
+$packageName = 'cloudsqlctl'
+$packageVersion = '0.4.15'
+
+$zipUrl = "https://github.com/Kinin-Code-Offical/cloudsqlctl/releases/download/v$packageVersion/cloudsqlctl-windows-x64.zip"
+$zipSha256 = 'ec77bf329e2ff67d25d33877ac0a13a1f4c8fccf39bb00cc2fde139a9ea9ad11'
+
+$toolsDir = Split-Path -Parent $MyInvocation.MyCommand.Definition
+
+Install-ChocolateyZipPackage -PackageName $packageName -Url $zipUrl -UnzipLocation $toolsDir -Checksum $zipSha256 -ChecksumType 'sha256'
+
+$exePath = Join-Path $toolsDir 'cloudsqlctl.exe'
+Install-BinFile -Name 'cloudsqlctl' -Path $exePath
+
+
diff --git a/chocolatey/cloudsqlctl/tools/chocolateyUninstall.ps1 b/chocolatey/cloudsqlctl/tools/chocolateyUninstall.ps1
@@ -0,0 +1,4 @@
+$ErrorActionPreference = 'Stop'
+
+Uninstall-BinFile -Name 'cloudsqlctl'
+
diff --git a/distribution/winget/README.md b/distribution/winget/README.md
@@ -0,0 +1,12 @@
+# Winget manifest template
+
+Winget publishing requires submitting a PR to `microsoft/winget-pkgs`.
+
+This folder contains a minimal manifest template you can adapt for the current version and submit upstream.
+
+Typical update steps:
+
+1. Update `PackageVersion` and `InstallerSha256` in `cloudsqlctl.yaml`.
+2. Ensure the download URL points to the GitHub Release installer for that version.
+3. Submit a PR to `https://github.com/microsoft/winget-pkgs`.
+
diff --git a/distribution/winget/cloudsqlctl.yaml b/distribution/winget/cloudsqlctl.yaml
@@ -0,0 +1,16 @@
+PackageIdentifier: KininCodeOffical.CloudSQLCTL
+PackageVersion: 0.4.15
+PackageName: CloudSQLCTL
+Publisher: Kinin-Code-Offical
+License: MIT
+ShortDescription: Windows-native CLI to install, update, and manage Google Cloud SQL Auth Proxy via gcloud.
+PackageUrl: https://github.com/Kinin-Code-Offical/cloudsqlctl
+InstallerType: inno
+Installers:
+  - Architecture: x64
+    InstallerUrl: https://github.com/Kinin-Code-Offical/cloudsqlctl/releases/download/v0.4.15/cloudsqlctl-setup.exe
+    InstallerSha256: 999c07b5957a70decc9754d7199dfef82c89cf1bdfa5d22ce0be7f6273a09d63
+ManifestType: singleton
+ManifestVersion: 1.6.0
+
+
diff --git a/docs/Distribution.md b/docs/Distribution.md
@@ -0,0 +1,40 @@
+# Distribution (Winget / Chocolatey / Scoop)
+
+This project primarily distributes releases via GitHub Releases.
+
+Additional package-manager distribution is optional and may require maintainers to publish to external registries.
+
+## Scoop (bucket in this repo)
+
+This repo includes a Scoop bucket manifest:
+- `scoop/cloudsqlctl.json`
+
+Install:
+
+```powershell
+scoop bucket add cloudsqlctl https://github.com/Kinin-Code-Offical/cloudsqlctl
+scoop install cloudsqlctl/cloudsqlctl
+```
+
+## Chocolatey (package skeleton in this repo)
+
+This repo includes a Chocolatey package skeleton under:
+- `chocolatey/cloudsqlctl`
+
+It is intended for maintainers to pack and publish (or for local/internal use).
+
+## Winget (template)
+
+Winget publishing is done via PRs to `microsoft/winget-pkgs`.
+
+This repo includes a template manifest under:
+- `distribution/winget/cloudsqlctl.yaml`
+
+## Updating manifests
+
+Use:
+
+```powershell
+powershell -ExecutionPolicy Bypass -File tools/update-distribution.ps1 -Version 0.4.15
+```
+
diff --git a/scoop/README.md b/scoop/README.md
@@ -0,0 +1,18 @@
+# Scoop bucket (in this repo)
+
+This repository includes a small Scoop bucket so you can install `cloudsqlctl` via Scoop without waiting for external registries.
+
+## Install
+
+```powershell
+scoop bucket add cloudsqlctl https://github.com/Kinin-Code-Offical/cloudsqlctl
+scoop install cloudsqlctl/cloudsqlctl
+```
+
+## Update
+
+```powershell
+scoop update
+scoop update cloudsqlctl
+```
+
diff --git a/scoop/cloudsqlctl.json b/scoop/cloudsqlctl.json
@@ -0,0 +1,11 @@
+{
+    "version":  "0.4.15",
+    "description":  "Windows-native CLI to install, update, and manage Google Cloud SQL Auth Proxy via gcloud.",
+    "homepage":  "https://github.com/Kinin-Code-Offical/cloudsqlctl",
+    "license":  "MIT",
+    "url":  "https://github.com/Kinin-Code-Offical/cloudsqlctl/releases/download/v0.4.15/cloudsqlctl-windows-x64.zip",
+    "hash":  "e6a65a7cec3a858bc3affb002e07ee04c09fd6ac42beac5811458deedd62ef84",
+    "bin":  [
+                "cloudsqlctl.exe"
+            ]
+}
diff --git a/tools/update-distribution.ps1 b/tools/update-distribution.ps1
@@ -0,0 +1,128 @@
+param(
+  [Parameter(Mandatory = $false)]
+  [string]$Version,
+
+  [Parameter(Mandatory = $false)]
+  [string]$Repo
+)
+
+$ErrorActionPreference = 'Stop'
+
+function Write-Utf8NoBomFile([string]$path, [string]$content) {
+  $utf8NoBom = New-Object Text.UTF8Encoding $false
+  [IO.File]::WriteAllText($path, $content, $utf8NoBom)
+}
+
+function Resolve-Repo {
+  if ($Repo) { return $Repo }
+
+  $remoteUrl = git remote get-url origin
+  if (-not $remoteUrl) { throw "Could not detect origin remote URL." }
+
+  if ($remoteUrl -match '^https://github\.com/(?<owner>[^/]+)/(?<repo>[^/.]+)(\.git)?$') {
+    return "$($Matches.owner)/$($Matches.repo)"
+  }
+  if ($remoteUrl -match '^git@github\.com:(?<owner>[^/]+)/(?<repo>[^/.]+)(\.git)?$') {
+    return "$($Matches.owner)/$($Matches.repo)"
+  }
+
+  throw "Unsupported origin remote URL format: $remoteUrl"
+}
+
+function Resolve-Version {
+  if ($Version) { return $Version }
+  $pkg = Get-Content package.json -Raw | ConvertFrom-Json
+  if (-not $pkg.version) { throw "package.json missing version" }
+  return [string]$pkg.version
+}
+
+function Get-ReleaseShaMap([string]$ownerRepo, [string]$ver) {
+  $tmp = Join-Path $env:TEMP ("cloudsqlctl-sums-" + [Guid]::NewGuid().ToString("n"))
+  New-Item -ItemType Directory -Path $tmp | Out-Null
+
+  try {
+    gh release download ("v$ver") --repo $ownerRepo --pattern "SHA256SUMS.txt" --dir $tmp | Out-Null
+    $sumsPath = Join-Path $tmp "SHA256SUMS.txt"
+    if (-not (Test-Path $sumsPath)) { throw "SHA256SUMS.txt not found in release v$ver" }
+
+    $map = @{}
+    foreach ($line in Get-Content $sumsPath) {
+      $t = $line.Trim()
+      if (-not $t) { continue }
+      $parts = $t -split '\s+'
+      if ($parts.Length -lt 2) { continue }
+      $hash = $parts[0].ToLowerInvariant()
+      $file = $parts[1]
+      $map[$file] = $hash
+    }
+    return $map
+  }
+  finally {
+    Remove-Item -Recurse -Force $tmp -ErrorAction SilentlyContinue
+  }
+}
+
+function Get-ReleaseAssetSha256([string]$ownerRepo, [string]$ver, [string]$assetName) {
+  $tmp = Join-Path $env:TEMP ("cloudsqlctl-asset-" + [Guid]::NewGuid().ToString("n"))
+  New-Item -ItemType Directory -Path $tmp | Out-Null
+
+  try {
+    gh release download ("v$ver") --repo $ownerRepo --pattern $assetName --dir $tmp | Out-Null
+    $assetPath = Join-Path $tmp $assetName
+    if (-not (Test-Path $assetPath)) { throw "Asset $assetName not found in release v$ver" }
+    return (Get-FileHash $assetPath -Algorithm SHA256).Hash.ToLowerInvariant()
+  }
+  finally {
+    Remove-Item -Recurse -Force $tmp -ErrorAction SilentlyContinue
+  }
+}
+
+$ownerRepo = Resolve-Repo
+$ver = Resolve-Version
+$sha = Get-ReleaseShaMap -ownerRepo $ownerRepo -ver $ver
+
+$zipName = 'cloudsqlctl-windows-x64.zip'
+$installerName = 'cloudsqlctl-setup.exe'
+
+if (-not $sha.ContainsKey($installerName)) { throw "Missing $installerName in SHA256SUMS.txt for v$ver" }
+
+$zipSha = if ($sha.ContainsKey($zipName)) { $sha[$zipName] } else { Get-ReleaseAssetSha256 -ownerRepo $ownerRepo -ver $ver -assetName $zipName }
+$installerSha = $sha[$installerName]
+
+$scoopPath = Join-Path $PSScriptRoot '..\scoop\cloudsqlctl.json'
+if (Test-Path $scoopPath) {
+  $json = Get-Content $scoopPath -Raw | ConvertFrom-Json
+  $json.version = $ver
+  $json.url = "https://github.com/$ownerRepo/releases/download/v$ver/$zipName"
+  $json.hash = $zipSha
+  Write-Utf8NoBomFile -path $scoopPath -content (($json | ConvertTo-Json -Depth 10) + "`n")
+}
+
+$nuspecPath = Join-Path $PSScriptRoot '..\chocolatey\cloudsqlctl\cloudsqlctl.nuspec'
+if (Test-Path $nuspecPath) {
+  $nuspec = Get-Content $nuspecPath -Raw
+  $nuspec = $nuspec -replace '<version>[^<]+</version>', "<version>$ver</version>"
+  Write-Utf8NoBomFile -path $nuspecPath -content ($nuspec + "`n")
+}
+
+$chocoInstallPath = Join-Path $PSScriptRoot '..\chocolatey\cloudsqlctl\tools\chocolateyInstall.ps1'
+if (Test-Path $chocoInstallPath) {
+  $ps1 = Get-Content $chocoInstallPath -Raw
+  $ps1 = $ps1 -replace "(?m)^(\\$packageVersion\\s*=\\s*)'.*'$", "`$1'$ver'"
+  $ps1 = $ps1 -replace "(?m)^(\\$zipSha256\\s*=\\s*)'.*'$", "`$1'$zipSha'"
+  Write-Utf8NoBomFile -path $chocoInstallPath -content ($ps1 + "`n")
+}
+
+$wingetPath = Join-Path $PSScriptRoot '..\distribution\winget\cloudsqlctl.yaml'
+if (Test-Path $wingetPath) {
+  $yaml = Get-Content $wingetPath -Raw
+  $yaml = $yaml -replace "(?m)^PackageVersion:\\s*.*$", "PackageVersion: $ver"
+  $yaml = $yaml -replace "(?m)^\\s*InstallerUrl:\\s*.*$", "    InstallerUrl: https://github.com/$ownerRepo/releases/download/v$ver/$installerName"
+  $yaml = $yaml -replace "(?m)^\\s*InstallerSha256:\\s*.*$", "    InstallerSha256: $installerSha"
+  Write-Utf8NoBomFile -path $wingetPath -content ($yaml + "`n")
+}
+
+Write-Host "Updated distribution manifests for v$ver in:" -ForegroundColor Green
+Write-Host "- scoop/cloudsqlctl.json"
+Write-Host "- chocolatey/cloudsqlctl/*"
+Write-Host "- distribution/winget/cloudsqlctl.yaml"

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +$ErrorActionPreference = 'Stop'
++
 +Uninstall-BinFile -Name 'cloudsqlctl'
++