devopsinfra/template-action

🚀 GitHub Action 模板GitHub Actions的模板仓库## 📦 可用地址

-** Docker Hub:https://hub.docker.com/repository/docker/devopsinfra/template-action - GitHub Packages:**https://github.com/devops-infra/template-action/pkgs/container/template-action

✨ 特性

• 为DevOps-Infra项目提供GitHub Actions的基础框架

🔗 相关Actions

查看DevOps-Infra的其他Actions

📊 徽章

https://img.shields.io/badge/GitHub-devops--infra%2Ftemplate--action-blueviolet.svg?style=plastic&logo=github !https://img.shields.io/github/last-commit/devops-infra/template-action?color=blueviolet&logo=github&style=plastic&label=%E6%9C%80%E5%90%8E%E6%8F%90%E4%BA%A4 !https://img.shields.io/github/languages/code-size/devops-infra/template-action?color=blueviolet&label=%E4%BB%A3%E7%A0%81%E5%A4%A7%E5%B0%8F&style=plastic&logo=github !https://img.shields.io/github/license/devops-infra/template-action?color=blueviolet&logo=github&style=plastic&label=%E8%AE%B8%E5%8F%AF%E8%AF%81 ](https://github.com/devops-infra/template-action "shields.io")
https://img.shields.io/badge/DockerHub-devopsinfra%2Ftemplate--action-blue.svg?style=plastic&logo=docker !https://img.shields.io/docker/v/devopsinfra/template-action?color=blue&label=%E7%89%88%E6%9C%AC&logo=docker&style=plastic&sort=semver !https://img.shields.io/docker/image-size/devopsinfra/template-action/latest?label=%E9%95%9C%E5%83%8F%E5%A4%A7%E5%B0%8F&style=plastic&logo=docker !https://img.shields.io/docker/pulls/devopsinfra/template-action?color=blue&label=%E6%8B%89%E5%8F%96%E6%AC%A1%E6%95%B0&logo=docker&style=plastic ](https://hub.docker.com/r/devopsinfra/template-action "shields.io")

🏷️ 版本标签：vX, vX.Y, vX.Y.Z

本Action支持三种标签级别以实现灵活的版本控制：

• vX：主版本的最新补丁（例如：v1）。
• vX.Y：次版本的最新补丁（例如：v1.2）。
• vX.Y.Z：固定到特定版本（例如：v1.2.3）。

📖 API参考

yaml
    - name: 运行Action
      uses: devops-infra/template-action@v1.0.8
      env:
        barfoo: foobaz
      with:
        foobar: bazbar
        debug: false
        # github_token: ${{ secrets.GITHUB_TOKEN }}

🔨 环境变量

🔧 输入参数

📤 输出参数

💻 使用示例

📝 基础示例

使用默认配置运行Action。

yaml
name: 在每次提交时运行Action
on: [push]
jobs:
  template-action:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6

      - uses: devops-infra/template-action@v1

🔀 高级示例

使用自定义输入运行Action。

yaml
name: 在每次提交时运行Action
on: [push]
jobs:
  template-action:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6

      - uses: devops-infra/template-action@v1
        with:
          foobar: hello
          debug: 'true'

🎯 使用特定版本

根据稳定性需求选择标签级别：

• vX.Y.Z：精确的不可变版本（最可预测）
• vX.Y：次版本内的最新补丁
• vX：主版本内的最新补丁

yaml
name: 在每次提交时运行Action
on: [push]
jobs:
  template-action:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6

      - uses: devops-infra/template-action@v1.0.8
        id: 固定补丁版本

      - uses: devops-infra/template-action@v1.0
        id: 固定次版本

      - uses: devops-infra/template-action@v1
        id: 固定主版本

🏗️ CI/CD

包含的工作流：

• （自动）创建拉取请求（.github/workflows/auto-pull-request-create.yml）
  • 触发条件：推送到除master和dependabot/**之外的任何分支。
  • 任务：
    • 代码检查
    • 构建并推送多平台测试镜像，检查清单
    • 创建拉取请求
• （自动）创建发布（.github/workflows/auto-create-release.yml）
  • 触发条件：拉取请求关闭且推送到release/**（仅对来自release/的合并PR运行）
  • 任务：
    • 代码检查
    • 打标签：创建vX.Y.Z；更新vX.Y和vX（如果远程已存在完整标签则失败）
    • 构建并推送多平台镜像，检查清单
    • 发布GitHub Release
    • 更新Docker Hub描述
• （定时）每周依赖构建（.github/workflows/cron-dependency-update.yml）
  • 触发条件：每周一08:00 UTC
  • 任务：
    • 代码检查
    • 构建并推送多平台测试镜像，检查清单
• （手动）更新版本（.github/workflows/manual-release-create.yml）
  • 触发条件：手动workflow_dispatch，包含type（patch|minor|major|set），当type=set时需提供version
  • 推送至release/**分支并创建拉取请求以创建新发布
  • 任务：
    • 更新版本：升级或设置；输出REL_VERSION
    • 构建并推送多平台镜像，检查清单
    • 创建拉取请求，批准后创建发布

🧑‍💻 开发

前提条件：

• 带Buildx的Docker，
• Task（通过工作流安装或从[***]
• macOS需安装gnu-sed（brew install gnu-sed），
• pre-commit（可选）。

常用任务：

bash
# 运行所有代码检查
task lint

# 本地构建多架构镜像（不推送）
task docker:build

# 推送镜像（需要DOCKER_TOKEN和GITHUB_TOKEN）
DOCKER_TOKEN=... GITHUB_TOKEN=... task docker:push

Pre-commit钩子：

bash
brew install pre-commit
task pre-commit:install
task pre-commit

🤝 贡献

欢迎贡献！详见https://github.com/devops-infra/.github/blob/master/CONTRIBUTING.md%E3%80%82 本项目采用MIT许可证 - 详见LICENSE文件。

📄 许可证

本项目采用MIT许可证 - 详见LICENSE文件。

💬 支持

如有任何问题或需要帮助，请：

• 📝 创建https://github.com/devops-infra/template-action/issues
• 🌟 如果你觉得有用，请Star本仓库！

🧪 端到端验证

模板Action的端到端验证现已纳入集中式组织流程。

• 拉取请求：通过可重用的组织工作流钩子自动运行。
• 发布分支准备：针对发布候选引用自动运行。
• 发布创建：针对生产发布引用自动运行。

手动执行选项：

• 仓库本地调用工作流：.github/workflows/manual-e2e-validate.yml
• 直接调用集中式工作流：devops-infra/triglav/.github/workflows/e2e-action-template-action.yml

执行模式：

• mode=ref 针对稳定的固定Action引用验证面向引用的端到端路径。
• mode=image 已连接但目前在本Action的中央端到端工作流中仅为占位符。

触发输入示例：

text
mode=ref

text
mode=image
image_tag=v1.2.3-test

🔄 分叉

要从分叉仓库发布镜像，请设置以下变量使Task使用你的 registry 身份：DOCKER_USERNAME、DOCKER_ORG_NAME、GITHUB_USERNAME、GITHUB_ORG_NAME。

两种支持的方式（环境变量优先于.env）：

bash
# .env（仅本地，不提交）
DOCKER_USERNAME=你的dockerhub用户
DOCKER_ORG_NAME=你的dockerhub组织
GITHUB_USERNAME=你的github用户
GITHUB_ORG_NAME=你的github组织

bash
# Shell覆盖
DOCKER_USERNAME=你的dockerhub用户 \
DOCKER_ORG_NAME=你的dockerhub组织 \
GITHUB_USERNAME=你的github用户 \
GITHUB_ORG_NAME=你的github组织 \
task docker:build

推荐设置：

• 本地开发：使用.env文件。
• GitHub Actions：为上述四个值设置仓库变量，并为DOCKER_TOKEN和GITHUB_TOKEN设置密钥。

不发布版本直接推送镜像：

• 使用build_only: true运行“（手动）创建发布”工作流，以构建和推送镜像而不标记发布。