From c88bf04a0d822ef6bf131ed79c2f88d4b239ca8b Mon Sep 17 00:00:00 2001 From: chenkailing <632104866@qq.com> Date: Sat, 11 Apr 2026 15:54:11 +0800 Subject: [PATCH] feat: add master auto deploy workflow --- .../deploy_windows_winrm.cpython-312.pyc | Bin 0 -> 5822 bytes .github/scripts/deploy_windows_winrm.py | 108 +++++++++++++ .github/scripts/remote_windows_deploy.ps1 | 143 ++++++++++++++++++ .github/workflows/master-auto-deploy.yml | 71 +++++++++ doc/ci-auto-deploy.md | 41 +++++ 5 files changed, 363 insertions(+) create mode 100644 .github/scripts/__pycache__/deploy_windows_winrm.cpython-312.pyc create mode 100644 .github/scripts/deploy_windows_winrm.py create mode 100644 .github/scripts/remote_windows_deploy.ps1 create mode 100644 .github/workflows/master-auto-deploy.yml create mode 100644 doc/ci-auto-deploy.md diff --git a/.github/scripts/__pycache__/deploy_windows_winrm.cpython-312.pyc b/.github/scripts/__pycache__/deploy_windows_winrm.cpython-312.pyc new file mode 100644 index 0000000000000000000000000000000000000000..6486971f99fb42d77da62bbf45c25fe9a94498cb GIT binary patch literal 5822 zcmb_gO;8(07M{^R`j_|>KW2gfAsd0gfH5&-!GOWWh(!V?PGXhN3`Rm|l$nt+TB)o} z?ZK`}l}YWvN+quN$d-NJn5x}_kEz-Sza{pPP0ixGqJ#lK!ees9IFpAjJ!U8Qrl3!O(8iII2=yIF4Wo47=)ZmOhK zeN!#9nwuI@MQKSjrCryMnm=f6>LglQ!E~e!Fg>ZS@)&?N0DsN8imZXYkus6S%^nP6 zEGmpL!_WA%qR3Oc-1!{e!9AvbB4Sb0#6w$@sADKD$;87I4v9|#wHkhhai|_)Ty-p} zlE&Yt(y+Uy6+EhaV@M)o9Wr}%|?>PWXV?#DdpMG;H6uSZxm62DC_ z)Mv>ELy-g(zY}5T_!brCh&v%B5?YHXRadYeTpv(=Z_5lxl# zgCL!;z+~ieb_A*{Ry125&OeynC391PxxHZS%A30cvpYNU!elR6oA{Qg=R?oCdDpyP zy~-P|9+>Reg+rK$iF%S+4<%zRk7Sc};h28!85lNLlpT z1Fai|A7N=MS`9S-Duu*Jl^kGFfV{@tDV5vp!9_g-jthk;4_;Oq&8{eINU*`rk~Bv# z^#C@&kFA9&i-98^jz1XB)#gaSbeh+kmUIilShd)phb(Y71a?yT0wTSlUJ>M%rb`?>x`Oqq7`Ep>(Wp(*1})d6g(SLB|T|kViA7v?+=r@K_<8&uXhYX0nb$ z!6%ipUdF%1$a)2CP~Z&;T&KVr6?lyTZ&Kh@|ABm$0(GaPR7ciNR>(y#p|(>u6ir#IyM9(d8#VMMz*7yl_b(Q)bBmkX6#&x zJR{mF_m0}MJ*`Ts;lD`7v(ry2QJry+of#+Dm8nfTqU}e#a*ym*?As}?4ePm2zC3afC;k7=+I_B?pP zp3f_AWjqa?fDbEhWt@#DaHX6JiuiM-UC}<-k4Nn<$4hkJh+FPGt#mTYAoahB!goq- zNjEbl?!3HOx>=4oh}jmVMKRLy?ihGBDn~ucbiFN_;GguxMbUcgT5x)1X~FkVaL(rs zDCs5NazNA!UmP74okv_N{+Z>)$?G#pY-!T(zu{Y+R?c4b`2s1&<*`pTH)kU;YBfS_ zdx!hZiFHS!=4K`r0&~HY<%Lwk2FE4F`uhh4FZ7**zk#vQa|46@V&f6_%P+Ra&sXjl;uhG5)JCM>QxpnU-ymSmy zJWP}DBu?3loy$~$W+NQU>=5IGJ7snQl#I`l5>*S-B*R74Lt$+`t2WXB8#kh?XCMF>k#Ki1?c!^ZGjjwTIszy@F%SLXC+7KI# zL{j>SnP1~$DP8|IyA_H z2P>Oj8yWgFY{*9EjGZ$KLo<_M^h#Y~sC9|~Ye^gTb9BOOjI0wq0gC0kOCfFp4CZuu zh~E**VD&qccOFs&z?$8Jca~;gTIN6a&nU(gAuOaRQXSYyPy~uXLY7@uM!LYG6^#*fQ+Qs2C<4{hPov9TKrtUeiwP3>?L+v84s z?CvE#2G!sYa4mKquIL!uSG-GkQhc#H{pn_}1vDi$NWi}VshBX1JknY&at zDfxtsMZ!D8)J`JAvS4O3>P~e*XhBRPKXool`U5i`&Id00re}M`h@DQaVAZ=yZ{krRuoi5lb>(GUzG z&R|fi*@jFqC}q+$3>6}S9CeqIQVwu3Ioz_L9?8wK_^c%B;iVvv^5}KY|{)Wnkv~Z1Gj)^+>nlcFv-M3OQ>>_X8B3-s;l1?ypMWzOOx~A#Dj^FN@cOXg6*~ob`Nhm!=D-d z%f|D2!o&@J{6o;~BV5|diK9f3=-F!*h>Lvt7_h&Omuj>%nnShTtjkW9?3lq^&^PAw zjk$pz^sPmM>7ns~v0!M*8$ji6Tfb^8xO(%h-n|>&eaO3d1=sA4hARiQ+JdbejKCY( zUpnf+*N%qW&%QaG+Z3A5>|Oo4bJMPx>aZ!%(o5hUwA&sw+#wy3qP8#AJn=EwO#qzt{==@B^%}(Ejcl3{li-iZXxq^ zyy`f!_kqyyKL6e&Fu{07@lAT9I5P3wJz>Ph4=^Mq;Edx8b_x(81z_}VK~+0&tmE`| zt&aX7l&^L*+)vV7fJC6{G#F&i=Z-&N^$126ya+OBgh{@F8kSRu%5vWxQmDjYE)R?AOQt;n*cxp2M literal 0 HcmV?d00001 diff --git a/.github/scripts/deploy_windows_winrm.py b/.github/scripts/deploy_windows_winrm.py new file mode 100644 index 00000000..e24f46e5 --- /dev/null +++ b/.github/scripts/deploy_windows_winrm.py @@ -0,0 +1,108 @@ +#!/usr/bin/env python3 +import base64 +import os +import pathlib +import sys + +import winrm + + +def require_env(name: str) -> str: + value = os.getenv(name, "").strip() + if not value: + raise SystemExit(f"Missing required environment variable: {name}") + return value + + +def optional_env(name: str, default: str) -> str: + value = os.getenv(name, "").strip() + return value if value else default + + +def ps_quote(value: str) -> str: + return value.replace("'", "''") + + +def main() -> int: + host = require_env("KK_DEPLOY_HOST") + port = optional_env("KK_DEPLOY_PORT", "5985") + username = require_env("KK_DEPLOY_USERNAME") + password = require_env("KK_DEPLOY_PASSWORD") + deploy_root = optional_env("KK_DEPLOY_ROOT", r"C:\kkFileView-5.0") + health_url = optional_env("KK_DEPLOY_HEALTH_URL", "http://127.0.0.1:8012/") + artifact_name = optional_env("KK_DEPLOY_ARTIFACT_NAME", "kkfileview-server-jar") + repository = require_env("GITHUB_REPOSITORY_NAME") + run_id = require_env("GITHUB_RUN_ID_VALUE") + github_token = require_env("GITHUB_TOKEN_VALUE") + dry_run = optional_env("KK_DEPLOY_DRY_RUN", "false").lower() + + script_path = pathlib.Path(__file__).with_name("remote_windows_deploy.ps1") + script_body = script_path.read_text(encoding="utf-8") + + bootstrap = f""" +$Repository = '{ps_quote(repository)}' +$RunId = '{ps_quote(run_id)}' +$ArtifactName = '{ps_quote(artifact_name)}' +$GitHubToken = '{ps_quote(github_token)}' +$DeployRoot = '{ps_quote(deploy_root)}' +$HealthUrl = '{ps_quote(health_url)}' +$DryRun = '{ps_quote(dry_run)}' +""" + + payload = (bootstrap + "\n" + script_body).encode("utf-8-sig") + payload_b64 = base64.b64encode(payload).decode("ascii") + + endpoint = f"http://{host}:{port}/wsman" + session = winrm.Session(endpoint, auth=(username, password), transport="ntlm") + + remote_b64_path = r"C:\Windows\Temp\kkfileview_deploy.b64" + remote_ps1_path = r"C:\Windows\Temp\kkfileview_deploy.ps1" + + prep = session.run_ps( + f""" +$ErrorActionPreference = 'Stop' +if (Test-Path '{ps_quote(remote_b64_path)}') {{ Remove-Item '{ps_quote(remote_b64_path)}' -Force }} +if (Test-Path '{ps_quote(remote_ps1_path)}') {{ Remove-Item '{ps_quote(remote_ps1_path)}' -Force }} +New-Item -ItemType File -Path '{ps_quote(remote_b64_path)}' -Force | Out-Null +""" + ) + if prep.status_code != 0: + sys.stderr.write(prep.std_err.decode("utf-8", errors="ignore")) + return prep.status_code + + chunk_size = 1200 + for start in range(0, len(payload_b64), chunk_size): + chunk = payload_b64[start : start + chunk_size] + append = session.run_ps( + f"Add-Content -LiteralPath '{ps_quote(remote_b64_path)}' -Value '{chunk}'" + ) + if append.status_code != 0: + sys.stderr.write(append.std_err.decode("utf-8", errors="ignore")) + return append.status_code + + result = session.run_ps( + f""" +$ErrorActionPreference = 'Stop' +$raw = Get-Content -LiteralPath '{ps_quote(remote_b64_path)}' -Raw +[System.IO.File]::WriteAllBytes('{ps_quote(remote_ps1_path)}', [Convert]::FromBase64String($raw)) +powershell -NoProfile -ExecutionPolicy Bypass -File '{ps_quote(remote_ps1_path)}' +$code = $LASTEXITCODE +Remove-Item '{ps_quote(remote_b64_path)}' -Force -ErrorAction SilentlyContinue +Remove-Item '{ps_quote(remote_ps1_path)}' -Force -ErrorAction SilentlyContinue +exit $code +""" + ) + + stdout = result.std_out.decode("utf-8", errors="ignore").strip() + stderr = result.std_err.decode("utf-8", errors="ignore").strip() + + if stdout: + print(stdout) + if stderr: + print(stderr, file=sys.stderr) + + return result.status_code + + +if __name__ == "__main__": + raise SystemExit(main()) diff --git a/.github/scripts/remote_windows_deploy.ps1 b/.github/scripts/remote_windows_deploy.ps1 new file mode 100644 index 00000000..d1f7f954 --- /dev/null +++ b/.github/scripts/remote_windows_deploy.ps1 @@ -0,0 +1,143 @@ +$ErrorActionPreference = 'Stop' + +function Write-Step { + param([string]$Message) + Write-Host "==> $Message" +} + +$BinDir = Join-Path $DeployRoot 'bin' +$StartupScript = Join-Path $BinDir 'startup.bat' +$ReleaseDir = Join-Path $DeployRoot 'releases' +$DeployTmp = Join-Path $DeployRoot 'deploy-tmp' +$ArtifactZip = Join-Path $DeployTmp 'artifact.zip' +$ExtractDir = Join-Path $DeployTmp 'artifact' + +if (-not (Test-Path $DeployRoot)) { + throw "Deploy root not found: $DeployRoot" +} + +if (-not (Test-Path $BinDir)) { + throw "Bin directory not found: $BinDir" +} + +if (-not (Test-Path $StartupScript)) { + throw "Startup script not found: $StartupScript" +} + +$CurrentJar = Get-ChildItem $BinDir -Filter 'kkFileView-*.jar' | Sort-Object LastWriteTime -Descending | Select-Object -First 1 +if (-not $CurrentJar) { + throw "No kkFileView jar found in $BinDir" +} + +$JarName = $CurrentJar.Name +$JarPath = $CurrentJar.FullName + +Write-Step "Deploy root: $DeployRoot" +Write-Step "Current jar: $JarPath" +Write-Step "Startup script: $StartupScript" +Write-Step "Health url: $HealthUrl" + +if ($DryRun -eq 'true') { + Write-Step "Dry run enabled, remote validation finished" + return +} + +New-Item -ItemType Directory -Force -Path $ReleaseDir | Out-Null +New-Item -ItemType Directory -Force -Path $DeployTmp | Out-Null + +if (Test-Path $ArtifactZip) { + Remove-Item $ArtifactZip -Force +} + +if (Test-Path $ExtractDir) { + Remove-Item $ExtractDir -Recurse -Force +} + +$Headers = @{ + Authorization = "Bearer $GitHubToken" + Accept = "application/vnd.github+json" + "X-GitHub-Api-Version" = "2022-11-28" + "User-Agent" = "kkFileView-auto-deploy" +} + +$ArtifactsApi = "https://api.github.com/repos/$Repository/actions/runs/$RunId/artifacts" +Write-Step "Resolving workflow artifact: $ArtifactName" +$ArtifactsResponse = Invoke-RestMethod -Headers $Headers -Uri $ArtifactsApi -Method Get +$Artifact = $ArtifactsResponse.artifacts | Where-Object { $_.name -eq $ArtifactName } | Select-Object -First 1 + +if (-not $Artifact) { + throw "Artifact '$ArtifactName' not found for workflow run $RunId" +} + +Write-Step "Downloading artifact from GitHub Actions" +Invoke-WebRequest -Headers $Headers -Uri $Artifact.archive_download_url -OutFile $ArtifactZip +Expand-Archive -LiteralPath $ArtifactZip -DestinationPath $ExtractDir -Force + +$DownloadedJar = Get-ChildItem $ExtractDir -Filter 'kkFileView-*.jar' -Recurse | Select-Object -First 1 +if (-not $DownloadedJar) { + throw "No kkFileView jar found inside artifact '$ArtifactName'" +} + +$Timestamp = Get-Date -Format 'yyyyMMddHHmmss' +$BackupJar = Join-Path $ReleaseDir ("{0}.{1}.bak" -f $JarName, $Timestamp) + +function Stop-KkFileView { + $Processes = Get-CimInstance Win32_Process | Where-Object { + $_.Name -match '^java(\.exe)?$' -and $_.CommandLine -like "*-jar $JarName*" + } + + foreach ($Process in $Processes) { + Write-Step "Stopping java process $($Process.ProcessId)" + Stop-Process -Id $Process.ProcessId -Force -ErrorAction SilentlyContinue + } +} + +function Start-KkFileView { + Write-Step "Starting kkFileView" + Start-Process -FilePath 'cmd.exe' -ArgumentList '/c', "`"$StartupScript`"" -WorkingDirectory $BinDir -WindowStyle Hidden +} + +function Wait-Health { + param([string]$Url) + + for ($i = 0; $i -lt 24; $i++) { + Start-Sleep -Seconds 5 + try { + $Response = Invoke-WebRequest -Uri $Url -UseBasicParsing -TimeoutSec 5 + if ($Response.StatusCode -eq 200) { + return $true + } + } catch { + Start-Sleep -Milliseconds 200 + } + } + + return $false +} + +Write-Step "Backing up current jar to $BackupJar" +Copy-Item $JarPath $BackupJar -Force + +Stop-KkFileView +Start-Sleep -Seconds 3 + +Write-Step "Replacing jar with artifact output" +Copy-Item $DownloadedJar.FullName $JarPath -Force + +Start-KkFileView + +if (-not (Wait-Health -Url $HealthUrl)) { + Write-Step "Health check failed, rolling back" + Stop-KkFileView + Start-Sleep -Seconds 2 + Copy-Item $BackupJar $JarPath -Force + Start-KkFileView + + if (-not (Wait-Health -Url $HealthUrl)) { + throw "Deployment failed and rollback health check also failed" + } + + throw "Deployment failed, rollback completed successfully" +} + +Write-Step "Deployment completed successfully" diff --git a/.github/workflows/master-auto-deploy.yml b/.github/workflows/master-auto-deploy.yml new file mode 100644 index 00000000..7dcb0e64 --- /dev/null +++ b/.github/workflows/master-auto-deploy.yml @@ -0,0 +1,71 @@ +name: Master Auto Deploy + +on: + push: + branches: [ master ] + workflow_dispatch: + +permissions: + contents: read + actions: read + +jobs: + build: + runs-on: ubuntu-22.04 + + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + - name: Set up JDK 21 + uses: actions/setup-java@v4 + with: + java-version: '21' + distribution: temurin + cache: maven + + - name: Build with Maven + run: mvn -B package -Dmaven.test.skip=true --file pom.xml + + - name: Upload server jar artifact + uses: actions/upload-artifact@v4 + with: + name: kkfileview-server-jar + path: server/target/kkFileView-*.jar + retention-days: 7 + + deploy-windows: + needs: build + runs-on: ubuntu-22.04 + env: + GITHUB_REPOSITORY_NAME: ${{ github.repository }} + GITHUB_RUN_ID_VALUE: ${{ github.run_id }} + GITHUB_TOKEN_VALUE: ${{ github.token }} + KK_DEPLOY_HOST: ${{ secrets.KK_DEPLOY_HOST }} + KK_DEPLOY_PORT: ${{ secrets.KK_DEPLOY_PORT }} + KK_DEPLOY_USERNAME: ${{ secrets.KK_DEPLOY_USERNAME }} + KK_DEPLOY_PASSWORD: ${{ secrets.KK_DEPLOY_PASSWORD }} + KK_DEPLOY_ROOT: ${{ secrets.KK_DEPLOY_ROOT }} + KK_DEPLOY_HEALTH_URL: ${{ secrets.KK_DEPLOY_HEALTH_URL }} + KK_DEPLOY_ARTIFACT_NAME: kkfileview-server-jar + + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: '3.11' + + - name: Install WinRM dependencies + run: pip install pywinrm + + - name: Validate deploy secrets + run: | + test -n "$KK_DEPLOY_HOST" || (echo "Missing secret: KK_DEPLOY_HOST" && exit 1) + test -n "$KK_DEPLOY_USERNAME" || (echo "Missing secret: KK_DEPLOY_USERNAME" && exit 1) + test -n "$KK_DEPLOY_PASSWORD" || (echo "Missing secret: KK_DEPLOY_PASSWORD" && exit 1) + + - name: Deploy to Windows server + run: python .github/scripts/deploy_windows_winrm.py diff --git a/doc/ci-auto-deploy.md b/doc/ci-auto-deploy.md new file mode 100644 index 00000000..a9d54357 --- /dev/null +++ b/doc/ci-auto-deploy.md @@ -0,0 +1,41 @@ +# kkFileView master 自动部署 + +当前线上 Windows 服务器的实际部署信息如下： + +- 部署根目录：`C:\kkFileView-5.0` +- 运行 jar：`C:\kkFileView-5.0\bin\kkFileView-5.0.jar` +- 启动脚本：`C:\kkFileView-5.0\bin\startup.bat` +- 运行配置：`C:\kkFileView-5.0\config\test.properties` +- 健康检查地址：`http://127.0.0.1:8012/` + +服务器当前没有安装 `git` 和 `mvn`，因此自动部署链路采用： + +1. GitHub Actions 在 `master` 合并后构建 `kkFileView-*.jar` +2. 通过 WinRM 连接 Windows 服务器 +3. 由服务器从当前 workflow run 下载 jar artifact +4. 备份线上 jar，替换为新版本 +5. 使用现有 `startup.bat` 重启，并做健康检查 +6. 如果健康检查失败，则自动回滚旧 jar 并重新拉起 + +## 需要配置的 GitHub Secrets + +- `KK_DEPLOY_HOST` +- `KK_DEPLOY_PORT` +- `KK_DEPLOY_USERNAME` +- `KK_DEPLOY_PASSWORD` +- `KK_DEPLOY_ROOT` +- `KK_DEPLOY_HEALTH_URL` + +推荐值： + +- `KK_DEPLOY_PORT=5985` +- `KK_DEPLOY_ROOT=C:\kkFileView-5.0` +- `KK_DEPLOY_HEALTH_URL=http://127.0.0.1:8012/` + +## Workflow + +新增 workflow：`.github/workflows/master-auto-deploy.yml` + +- 触发条件：`push` 到 `master`，或手动 `workflow_dispatch` +- 构建产物：`kkfileview-server-jar` +- 部署方式：WinRM + GitHub Actions artifact 下载