在Git/GitHub渲染文件中使用参数的实现方案咨询

核心思路 #

借助GitHub Actions在构建/部署流程中，读取Git的标签、分支、提交哈希等元信息，替换代码模板中的占位符（如$$tag$$、$$branch$$、$$commit$$），再用替换后的代码完成编译或发布。

具体实现步骤 #

1. 准备代码模板文件 #

创建模板文件（例如about_template.py），写入带占位符的代码：

print("Program Name")
print("Version: $$tag$$")
if "develop" == "$$branch$$":
    print("Commit: $$commit$$")

注：语法可根据你使用的编程语言调整，这里以Python为例修正了原示例的语法问题

2. 编写GitHub Actions工作流 #

在仓库的.github/workflows/目录下创建工作流文件（例如replace-template.yml），内容如下：

name: Replace Template Variables
on: [push, release]  # 触发时机：代码推送或创建Release时

jobs:
  replace-and-build:
    runs-on: ubuntu-latest
    steps:
      - name: 拉取代码
        uses: actions/checkout@v4
        with:
          fetch-depth: 0  # 拉取完整Git历史，确保能获取标签、分支信息

      - name: 获取Git元信息
        id: git-info
        run: |
          # 获取当前分支名
          BRANCH_NAME=$(git rev-parse --abbrev-ref HEAD)
          # 获取短版本提交哈希
          COMMIT_HASH=$(git rev-parse --short HEAD)
          # 获取最近的标签，无标签时设为"unknown"
          TAG_NAME=$(git describe --tags --abbrev=0 2>/dev/null || echo "unknown")
          # 输出变量供后续步骤调用
          echo "branch=$BRANCH_NAME" >> $GITHUB_OUTPUT
          echo "commit=$COMMIT_HASH" >> $GITHUB_OUTPUT
          echo "tag=$TAG_NAME" >> $GITHUB_OUTPUT

      - name: 替换模板占位符
        run: |
          # 替换所有占位符，生成最终代码文件
          sed -i "s/\$\$tag\$\$/$(echo ${{ steps.git-info.outputs.tag }})/g" about_template.py
          sed -i "s/\$\$branch\$\$/$(echo ${{ steps.git-info.outputs.branch }})/g" about_template.py
          sed -i "s/\$\$commit\$\$/$(echo ${{ steps.git-info.outputs.commit }})/g" about_template.py
          # 将模板文件重命名为实际使用的文件名
          mv about_template.py about.py

      - name: 构建/发布（示例）
        run: |
          # 这里添加你的编译、打包命令，比如Python打包
          # python setup.py sdist bdist_wheel

3. 关键细节说明 #

• 变量获取：通过Git原生命令提取分支、提交哈希、标签信息，无标签时默认值可根据需求修改。
• 跨环境适配：如果使用Windows环境的runner，可将sed替换为PowerShell命令，例如：

  (Get-Content about_template.py) -replace '$$tag$$', '${{ steps.git-info.outputs.tag }}' | Set-Content about.py
  

• 触发时机：可修改on字段调整触发条件，比如仅在main分支推送或创建Release时执行。

扩展优化方向 #

• 多语言支持：编译型语言（如Java、C#）可在编译前替换模板文件（例如About.java.template→About.java），再执行编译流程。
• 变量扩展：可添加构建时间等更多变量，例如用$(date +%d-%m-%Y)替换$$date$$占位符。
• 避免污染仓库：无需将替换后的文件提交到仓库，仅在构建流程中动态生成即可。

内容的提问来源于stack exchange，提问作者technetium