GitHub Action Windows自托管多环境串行部署及复用步骤实现方法
部署复用实现方案
完全不需要为每个环境重复编写相同的部署段,GitHub Actions 原生提供了类似“可复用类”的能力,刚好匹配你多环境线性部署的需求,下面是两种落地方式,优先推荐第一种,适配刚接触的场景:
核心思路
你当前的部署逻辑除了「自托管Runner标签、IIS应用池名、站点名、部署物理路径、端口」这几个环境差异参数外,其他步骤完全一致,只要把通用部署逻辑封装成可传参的复用单元,再为每个环境传入对应参数、配置线性依赖即可,不用重复写步骤。
方案一:复合动作(Composite Action)复用(推荐新手)
复合动作就是你要的“类”概念:可以把一组通用步骤封装成独立单元,调用时传入不同参数即可生成适配不同场景的执行实例。
实现步骤
- 先优化原有构建Job,删除冗余逻辑
原代码里你为了传递构建号,额外上传了一个buildnumberapi的文本文件,完全没必要,直接用跨Job输出(Job Outputs)传递即可,先修改原有buildJob的配置:build: # 新增outputs块,暴露构建号给后续部署Job outputs: build-number: ${{ steps.buildnumber.outputs.build_number }} runs-on: dev-build strategy: matrix: dotnet-version: 3.1.301 # 原命名为node-version是笔误,改成更直观的dotnet-version env: api-project: "./Pash.Web/PASH.Api/PASH.Api.csproj" test-project: "./Pash.Web/PASH.Api.Test/PASH.Api.Test.csproj" upload-artifacts-path: "./pashdotnetcorewebapp" artifact-package-zip-directory-path: "_PASH-API-CI/Pash-drop" steps: # 保留你原有的所有步骤,删掉「Store Build Number on Build Server」、「Publish Upload Build File」这两个冗余步骤 - name: Generate build number id: buildnumber uses: einaregilsson/build-number@v3 with: token: ${{ secrets.github_token }} - uses: actions/checkout@v2 - name: Setup .NET Core - ${{ matrix.dotnet-version }} uses: actions/setup-dotnet@v1 with: dotnet-version: ${{ matrix.dotnet-version }} - name: Install dependencies run: dotnet restore ${{env.api-project}} - name: Build run: dotnet build ${{env.api-project}} --configuration Release --no-restore - name: Test run: dotnet test ${{env.test-project}} --no-restore --verbosity normal - name: Publish run: dotnet publish ${{env.api-project}} -c Release -o pashdotnetcorewebapp - name: Upload build artifact uses: actions/upload-artifact@v2 with: name: pash-api-artifact-${{ steps.buildnumber.outputs.build_number }} path: ${{ env.upload-artifacts-path }} - 封装通用部署复合动作
在你的代码仓库下新建目录.github/actions/deploy-pash-api/,在该目录下新建action.yaml文件,把原有的部署步骤全部搬进来,将硬编码的环境差异参数改成可传入的输入:name: "PASH API 通用部署步骤" description: "跨环境复用的PASH API部署逻辑" # 定义可传入的参数,相当于类的构造参数 inputs: pool-name: description: "目标环境的IIS应用池名称" required: true site-name: description: "目标环境的IIS站点名称" required: true physical-path: description: "目标环境的站点物理部署路径" required: true port-name: description: "目标环境的站点监听端口" required: true build-number: description: "需要部署的构建包编号" required: true runs: using: "composite" steps: # 通用部署逻辑,所有环境完全一致 - name: 下载对应构建包 uses: actions/download-artifact@v2 with: name: pash-api-artifact-${{ inputs.build-number }} path: ${{ github.workspace }}/_PASH-API-CI/Pash-drop - name: 执行PowerShell部署脚本 shell: pwsh # 未安装PowerShell 7可改为shell: powershell run: | & 'D:\github-deploy-ps.ps1' ${{ inputs.pool-name }} ${{ inputs.site-name }} ${{ inputs.physical-path }} ${{ inputs.port-name }} - 配置线性依赖的多环境部署Job
原工作流里新增4个部署Job,每个只需要调用一次上面的复合动作、传入对应环境的参数,并用needs配置依赖链,确保按Dev→QA→UAT→Prod的顺序执行(前一个失败直接终止后续部署):# Dev环境部署 deploy-dev: needs: [build] # 依赖构建成功 runs-on: dev-deploy # 调度到Dev环境的自托管Runner steps: - name: 调用通用部署动作 uses: ./.github/actions/deploy-pash-api with: pool-name: "PASHAPIDevPool" site-name: "PASHServicesAPIDevSite" physical-path: "D:\\sites\\pash-api-dev" port-name: 8081 build-number: ${{ needs.build.outputs.build-number }} # QA环境部署 deploy-qa: needs: [deploy-dev] # 依赖Dev部署成功才执行 runs-on: qa-deploy # 调度到QA环境的自托管Runner steps: - name: 调用通用部署动作 uses: ./.github/actions/deploy-pash-api with: pool-name: "PASHAPIQAPool" site-name: "PASHServicesAPIQASite" physical-path: "D:\\sites\\pash-api-qa" port-name: 8082 build-number: ${{ needs.build.outputs.build-number }} # UAT环境部署 deploy-uat: needs: [deploy-qa] # 依赖QA部署成功才执行 runs-on: uat-deploy steps: - name: 调用通用部署动作 uses: ./.github/actions/deploy-pash-api with: pool-name: "PASHAPIUATPool" site-name: "PASHServicesAPIUATSite" physical-path: "D:\\sites\\pash-api-uat" port-name: 8083 build-number: ${{ needs.build.outputs.build-number }} # Prod环境部署 deploy-prod: needs: [deploy-uat] # 依赖UAT部署成功才执行 runs-on: prod-deploy steps: - name: 调用通用部署动作 uses: ./.github/actions/deploy-pash-api with: pool-name: "PASHAPIProdPool" site-name: "PASHServicesAPIProdSite" physical-path: "D:\\sites\\pash-api-prod" port-name: 80 build-number: ${{ needs.build.outputs.build-number }}
方案二:矩阵优化(更简洁,适合后续环境扩展)
如果不想写4个独立的部署Job,可以用矩阵(Matrix)抽离环境参数,配合GitHub的环境保护规则实现顺序部署,配置后部署逻辑只需要写1个Job:
- 先在GitHub仓库的「Settings→Environments」下新建Dev、QA、UAT、Prod 4个环境,配置保护规则:
- Dev环境默认开放
- QA环境配置等待Dev部署完成后触发
- UAT环境配置等待QA部署完成后触发
- Prod环境配置等待UAT部署完成后触发,可按需加手动审批
- 部署Job配置如下:
deploy-all: needs: [build] strategy: fail-fast: false # 单个环境失败不终止其他环境部署 matrix: include: - env-name: dev runner-label: dev-deploy pool-name: "PASHAPIDevPool" site-name: "PASHServicesAPIDevSite" physical-path: "D:\\sites\\pash-api-dev" port-name: 8081 - env-name: qa runner-label: qa-deploy pool-name: "PASHAPIQAPool" site-name: "PASHServicesAPIQASite" physical-path: "D:\\sites\\pash-api-qa" port-name: 8082 # 其余UAT、Prod环境参数同理添加 runs-on: ${{ matrix.runner-label }} environment: ${{ matrix.env-name }} # 关联对应配置的GitHub环境,触发保护规则 steps: - name: 调用通用部署动作 uses: ./.github/actions/deploy-pash-api with: pool-name: ${{ matrix.pool-name }} site-name: ${{ matrix.site-name }} physical-path: ${{ matrix.physical-path }} port-name: ${{ matrix.port-name }} build-number: ${{ needs.build.outputs.build-number }}
注意事项
- 确保每个环境的自托管Runner都配置了对应的调度标签(比如
dev-deploy、qa-deploy),否则Actions无法正确调度到对应机器 - PowerShell脚本如果路径有变动,只需要修改复合动作里的路径即可,不用改每个环境的配置
- 如果后续其他项目也要复用这套部署逻辑,可以把
deploy-pash-api这个复合动作迁移到组织级公共仓库,所有项目直接引用即可,无需重复开发
内容的提问来源于stack exchange,提问作者fortanu82
相关产品推荐
相关产品推荐

