chuhlomin/render-template

Render Template

一个用于根据模板和传入变量渲染文件的GitHub Action。

概述

Render Template 是一个GitHub Action，旨在通过模板文件和提供的变量动态生成文件内容。它支持通过YAML格式的变量或YAML文件传入数据，灵活适用于各类配置文件生成场景。

核心功能和特性

• 支持指定模板文件路径
• 接受YAML格式的变量直接输入或通过YAML文件传入
• 可指定结果文件路径（可选）
• 输出渲染后的文件内容，便于后续流程使用
• 变量优先级：直接传入的vars优先于vars_path指定的文件变量

输入参数 (Inputs)

注意：必须至少设置vars或vars_path。若同时设置，vars的值将覆盖vars_path中的同名变量。

输出参数 (Outputs)

使用场景和适用范围

适用于GitHub Actions工作流中需要动态生成配置文件的场景，例如：

• Kubernetes部署配置文件生成
• 环境特定的配置文件生成
• 动态生成CI/CD流程中的配置文件

使用示例

模板文件示例 (kube.template.yml)

yml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: {{ .deployment }}
  labels:
    app: {{ .app }}
spec:
  replicas: 3
  selector:
    matchLabels:
      app: {{ .app }}
  template:
    metadata:
      labels:
        app: {{ .app }}
    spec:
      containers:
      - name: {{ .app }}
        image: {{ .image }}
        ports:
        - containerPort: 80

GitHub工作流配置示例 (.github/workflows/main.yml)

yml
name: main
on:
  push:
    branches:
      - main
env:
  DOCKER_IMAGE: username/image
  DEPLOYMENT_NAME: nginx-deployment
jobs:
  main:
    runs-on: ubuntu-latest
    steps:
      - name: 检出代码
        uses: actions/checkout@v3

      <...>  # 其他步骤

      - name: 渲染模板
        id: render_template
        uses: chuhlomin/render-template@v1.6
        with:
          template: kube.template.yml
          vars: |
            image: ${{ env.DOCKER_IMAGE }}:${{ github.sha }}
            deployment: ${{ env.DEPLOYMENT_NAME }}
            app: nginx

      - name: 部署
        timeout-minutes: 4
        run: |-
          echo '${{ steps.render_template.outputs.result }}' | kubectl apply -f -
          kubectl rollout status deployment/$DEPLOYMENT_NAME