byndid/auth-commit-sig

auth-commit-sig GitHub Action 支持镜像

镜像概述

该Docker镜像专为支持auth-commit-sig GitHub Action设计，提供认证与提交签名相关的运行环境及工具，旨在助力开发者在GitHub工作流中实现安全、可靠的提交验证与签名操作，确保代码提交的完整性与真实性。

核心功能与特性

• 认证流程支持：集成auth-commit-sig Action所需的认证机制，支持与GitHub API及相关服务的安全交互。
• 提交签名生成：提供提交签名所需的工具链，能够根据配置生成符合规范的提交签名。
• GitHub环境集成：适配GitHub Actions运行环境，确保与工作流中的其他步骤无缝协作。
• 轻量级设计：优化镜像体积，减少工作流执行时间，提升运行效率。

使用场景与适用范围

• 代码提交安全保障：在GitHub仓库的代码提交流程中，对提交进行签名验证，防止未授权或篡改的提交。
• 合规性检查：满足团队或组织对代码提交必须经过签名验证的合规性要求。
• 自动化工作流增强：作为GitHub Actions工作流的一部分，自动化实现提交签名流程，减少人工操作。

使用方法与配置说明

在GitHub Action中引用

在GitHub Actions工作流文件（如.github/workflows/auth-commit-sig.yml）中，通过container字段引用该镜像，配合auth-commit-sig Action使用。

基本示例

yaml
name: Auth Commit Sig Workflow
on: [push, pull_request]

jobs:
  sig-verify:
    runs-on: ubuntu-latest
    container:
      image: docker.xuanyuan.run/<镜像名称>:<标签>  # 替换为实际的镜像名称和标签
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
      
      - name: Run auth-commit-sig Action
        uses: <auth-commit-sig Action仓库>@v1  # 替换为auth-commit-sig Action的实际地址
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          SIGNING_KEY: ${{ secrets.SIGNING_KEY }}  # 提交签名所需的密钥

配置参数与环境变量

注意事项

• 需在GitHub仓库中配置SIGNING_KEY等敏感信息为Secrets，避免明文暴露。
• 根据auth-commit-sig Action版本选择匹配的镜像标签，确保功能兼容性。
• 工作流中需先执行代码检出步骤（如actions/checkout），再进行签名操作。