devopsinfra/action-commit-push Docker镜像文档

镜像概述和主要用途

devopsinfra/action-commit-push是一个功能强大的Docker镜像，作为GitHub Action使用，用于自动提交更改并推回至代码仓库。该镜像特别适用于自动化工作流，可与devops-infra/action-pull-request无缝集成，实现完整的自动化提交与PR流程。

主要变更 (v0.11.0)

• 强制推送行为更新：force: true 现在使用 git push --force（破坏性变更）
• 新增参数：force_with_lease 用于更安全的强制推送，使用 --force-with-lease
• 修正功能改进：现在可结合 amend: true 与 commit_message 来更改提交信息
• 发布流程：完全自动化的发布流程 - 无需任何手动操作！

获取镜像

该镜像可从以下平台获取：

• Docker Hub: devopsinfra/action-commit-push:latest
• GitHub Packages: ghcr.io/devops-infra/action-commit-push:latest

核心功能与特性

• 自定义提交信息：可为提交添加自定义前缀和消息
• 分支管理：自动创建新分支，可选添加时间戳
• 时间戳支持：为基于定时任务的更新在分支名称中添加时间戳
• 集成就绪：与其他DevOps工作流无缝协作
• 强制推送选项：支持必要时使用 --force 和 --force-with-lease
• 拉取请求集成：自动化PR工作流的理想伴侣

使用场景与适用范围

• 自动化文档更新和版本管理
• 定时任务触发的代码更改提交
• CI/CD流程中生成文件的自动提交
• 跨分支代码同步与更新
• 需要保留提交历史的自动化更改
• 与PR流程结合的完整自动化开发流程

使用方法与配置说明

API参考

- name: 运行Action
  uses: devops-infra/action-commit-push@v1.0.0
  with:
    github_token: "${{ secrets.GITHUB_TOKEN }}"
    add_timestamp: true
    amend: false
    commit_prefix: "[AUTO]"
    commit_message: "自动提交"
    force: false
    force_with_lease: false
    no_edit: false
    organization_domain: github.com
    target_branch: update/version

输入参数

输出参数

使用示例

基本示例

提交并推送更改到当前检出的分支。

name: 运行Action
on:
  push
jobs:
  change-and-push:
    runs-on: ubuntu-latest
    steps:
      - name: 检出仓库
        uses: actions/checkout@v5
      - name: 修改文件
        run: |
          find . -type f -name "*.md" -print0 | xargs -0 sed -i "s/foo/bar/g"

      - name: 提交并推送更改
        uses: devops-infra/action-commit-push@v1.0.0
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          commit_message: "将foo替换为bar"

高级示例

提交并推送更改到新分支，并使用 devops-infra/action-pull-request 创建拉取请求。

name: 推送更改并创建PR
on:
  push
jobs:
  change-and-push:
    runs-on: ubuntu-latest
    steps:
      - name: 检出仓库
        uses: actions/checkout@v5
      - name: 修改文件
        run: |
          find . -type f -name "*.md" -print0 | xargs -0 sed -i "s/foo/bar/g"

      - name: 提交并推送更改
        uses: devops-infra/action-commit-push@v.11.4
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          commit_prefix: "[自动提交] "
          commit_message: "将foo替换为bar"

      - name: 创建拉取请求
        uses: devops-infra/action-pull-request@v1
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          body: "**自动化拉取请求**<br><br>将foo替换为bar"
          title: ${{ github.event.commits[0].message }}

强制推送示例

当需要修正前一次提交并强制推送时（在手动提交中添加自动更改时非常有用）。

name: 修正并强制推送
on:
  workflow_dispatch:
    inputs:
      new_commit_message:
        description: '新的提交消息'
        required: true
        default: '更新的提交消息'

jobs:
  amend-commit:
    runs-on: ubuntu-latest
    steps:
      - name: 检出完整历史的仓库
        uses: actions/checkout@v5
        with:
          fetch-depth: 0  # 对于force_with_lease是必需的
      - name: 进行一些更改
        run: |
          echo "附加内容" >> README.md

      - name: 修正并带租约强制推送
        uses: devops-infra/action-commit-push@v1.0.0
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          commit_message: ${{ github.event.inputs.new_commit_message }}
          amend: true
          force_with_lease: true  # 更安全的强制推送选项

提交修正选项

使用 amend: true 时，有几种处理提交消息的选项：

1. 更改提交消息：设置 commit_message 以提供新消息

   - uses: devops-infra/action-commit-push@v1.0.0
     with:
       github_token: ${{ secrets.GITHUB_TOKEN }}
       commit_message: "修复文档中的拼写错误"
       amend: true
       force_with_lease: true
   

2. 保留现有消息：设置 no_edit: true 以保留原始提交消息

   - uses: devops-infra/action-commit-push@v1.0.0
     with:
       github_token: ${{ secrets.GITHUB_TOKEN }}
       amend: true
       no_edit: true
       force_with_lease: true
   

3. 默认行为：如果两者都未设置，则使用"Files changed:"加上文件列表（当文件被修改时）

注意：即使没有文件更改，修正也能工作 - 仅更改提交消息时非常有用！

强制推送选项

此操作提供两种不同场景的强制推送选项：

force_with_lease (推荐)

• 使用 git push --force-with-lease
• 更安全的选项，会检查是否有其他人已向远程分支推送更改
• 防止意外覆盖他人的工作
• 要求：在 actions/checkout 步骤中设置 fetch-depth: 0
• 使用场景：修正提交、变基或其他历史修改操作

force (谨慎使用)

• 使用 git push --force
• 有潜在危险，会无条件覆盖远程更改
• 没有安全检查 - 会覆盖任何远程更改
• 使用场景：仅在确定要覆盖远程更改时使用

重要：不要同时使用这两个选项。如果同时设置为 true，force_with_lease 优先。

指定版本使用

使用特定版本标签运行Action。

name: 运行Action
on:
  push:
    branches-ignore: master
jobs:
  action-commit-push:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v5

      - uses: devops-infra/action-commit-push@v1.0.0
        id: 固定补丁版本

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

      - uses: devops-infra/action-commit-push@v1
        id: 固定主要版本

相关Actions

• devops-infra/action-pull-request - 自动创建拉取请求

贡献

欢迎贡献！详见CONTRIBUTING。 本项目采用MIT许可证 - 详见LICENSE文件。

许可证

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

支持

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

• 📝 创建issue
• 🌟 如果你觉得有用，请给这个仓库点赞！