owain94/create-pull-request

Create Pull Request GitHub Action镜像

镜像概述

这是一个GitHub Action镜像，用于在Actions工作区中为仓库的更改自动创建拉取请求（PR）。它可与其他修改或添加仓库文件的步骤配合使用，将更改提交到新分支或更新现有PR分支，并生成PR以合并到当前活跃分支。

核心功能

1. 检查更改：检测Actions工作区中的仓库更改，包括未跟踪（新）文件和已修改文件。
2. 提交分支：将所有更改提交到新分支或更新现有PR分支，提交信息使用HEAD提交作者的名称和***。
3. 创建PR：生成PR以将新分支合并到当前执行工作流的活跃分支。

使用场景

• 自动化生成报告文件后创建PR（如示例中的report.txt）。
• 动态配置PR标题、内容、标签等参数，适应不同场景需求。
• 多平台（Linux、MacOS、Windows）下的PR自动化创建。

配置说明

环境变量（可选）

若未设置，将使用默认值：

• COMMIT_MESSAGE：提交更改时使用的消息。
• PULL_REQUEST_TITLE：PR标题。
• PULL_REQUEST_BODY：PR正文内容。
• PULL_REQUEST_LABELS：逗号分隔的标签列表。
• PULL_REQUEST_ASSIGNEES：逗号分隔的负责人（GitHub用户名）列表。
• PULL_REQUEST_REVIEWERS：逗号分隔的审核人（GitHub用户名）列表。
• PULL_REQUEST_TEAM_REVIEWERS：逗号分隔的GitHub团队审核人列表。
• PULL_REQUEST_MILESTONE：关联的里程碑编号。
• PULL_REQUEST_BRANCH：分支名称，默认值为create-pull-request/patch。
• BRANCH_SUFFIX：分支后缀类型，可选值为short-commit-hash（默认）、timestamp、random、none。

输出变量

• PULL_REQUEST_NUMBER：创建的PR编号。

调试参数

• DEBUG_EVENT：输出触发工作流的事件数据。
• SKIP_IGNORE：跳过ignore_event函数。

分支命名策略

策略A：每次创建新PR分支（默认）

通过BRANCH_SUFFIX设置分支后缀：

• short-commit-hash：后缀为短SHA1哈希（如create-pull-request/patch-fcdfb59）。
• timestamp：后缀为时间戳（如create-pull-request/patch-1569322532）。
• random：后缀为随机字母数字字符串（适用于同一工作流创建多个PR的场景）。

策略B：创建并更新固定PR分支

设置BRANCH_SUFFIX为none，使用PULL_REQUEST_BRANCH指定的固定分支名，后续更改将提交到同一分支并更新现有PR。

忽略文件

可在仓库根目录添加.gitignore文件，该镜像会尊重此文件中的忽略规则。

部署示例

Linux环境使用

yml
- name: 创建拉取请求
  uses: peter-evans/create-pull-request@v1.5.0
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

多平台环境使用（Linux、MacOS、Windows，测试版）

yml
- name: 创建拉取请求
  uses: peter-evans/create-pull-request@v1.5.0-multi
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

完整工作流示例

yml
on:
  repository_dispatch:
    types: [create-pull-request]
name: create-pull-request工作流
jobs:
  createPullRequest:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v1
      - name: 创建报告文件
        run: date +%s > report.txt
      - name: 创建拉取请求
        uses: peter-evans/create-pull-request@v1.5.0
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          COMMIT_MESSAGE: 添加报告文件
          PULL_REQUEST_TITLE: '[示例] 添加报告文件'
          PULL_REQUEST_BODY: >
            此PR由[create-pull-request](https://github.com/peter-evans/create-pull-request)自动生成。
          PULL_REQUEST_LABELS: report, automated pr
          PULL_REQUEST_ASSIGNEES: peter-evans
          PULL_REQUEST_REVIEWERS: peter-evans
          PULL_REQUEST_MILESTONE: 1
          PULL_REQUEST_BRANCH: example-patches
          BRANCH_SUFFIX: short-commit-hash
      - name: 检查输出变量
        run: echo "拉取请求编号 - $PULL_REQUEST_NUMBER"

动态配置示例

方法1：使用set-output（推荐）

yml
- name: 设置输出变量
  id: vars
  run: |
    echo ::set-output name=pr_title::"[测试] 添加报告文件 $(date +%d-%m-%Y)"
    echo ::set-output name=pr_body::"此PR于$(date +%d-%m-%Y)由[create-pull-request](https://github.com/peter-evans/create-pull-request)自动生成。"
- name: 创建拉取请求
  uses: peter-evans/create-pull-request@v1.5.0
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
    PULL_REQUEST_TITLE: ${{ steps.vars.outputs.pr_title }}
    PULL_REQUEST_BODY: ${{ steps.vars.outputs.pr_body }}

方法2：使用set-env

yml
- name: 设置环境变量
  run: |
    echo ::set-env name=PULL_REQUEST_TITLE::"[测试] 添加报告文件 $(date +%d-%m-%Y)"
    echo ::set-env name=PULL_REQUEST_BODY::"此PR于$(date +%d-%m-%Y)由[create-pull-request](https://github.com/peter-evans/create-pull-request)自动生成。"
- name: 创建拉取请求
  uses: peter-evans/create-pull-request@v1.5.0
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

许可证

MIT