Skip to content

Latest commit

 

History

History
111 lines (87 loc) · 3.96 KB

README.zh-CN.md

File metadata and controls

111 lines (87 loc) · 3.96 KB
Raw

Milestone Action

功能

  • 自动为已合并的 PR 添加里程碑
  • 自动为已合并修复PR的关闭 issue 添加里程碑
  • 通过标题、描述和截止日期创建里程碑
  • 通过标题或里程碑编号关闭里程碑
  • 通过标题或里程碑编号删除里程碑

使用方法

自动为已合并的 PR 或为已合并修复PR的关闭 issue 添加里程碑：

name: Milestone Action
on:
  issues:
    types: [closed]
  pull_request_target:
    types: [closed]

jobs:
  update-milestone:
    runs-on: ubuntu-latest
    name: Milestone Update
    steps:
      - name: Set Milestone for PR
        uses: hustcer/milestone-action@v2
        if: github.event.pull_request.merged == true
        with:
          action: bind-pr   # `bind-pr` is the default action
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

      # Bind milestone to closed issue that has a merged PR fix
      - name: Set Milestone for Issue
        uses: hustcer/milestone-action@v2
        if: github.event.issue.state == 'closed'
        with:
          action: bind-issue
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

通过标题、描述和截止日期创建里程碑：

- name: Create Milestone
  uses: hustcer/milestone-action@v2
  with:
    action: create
    title: v1.0
    due-on: 2025-05-01
    description: 'The first milestone of the project.'
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

通过标题或里程碑编号关闭里程碑：

- name: Close Milestone
  uses: hustcer/milestone-action@v2
  with:
    action: close
    milestone: v1.0   # 里程碑标题或编号
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

通过标题或里程碑编号删除里程碑：

- name: Delete Milestone
  uses: hustcer/milestone-action@v2
  with:
    action: delete
    milestone: v1.0   # Milestone title or number
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

输入参数

名称 类型 描述
action String 要执行的操作, 可能的值未：create, close, delete, bind-pr, bind-issue，默认为 bind-pr
title String 要创建的里程碑标题
due-on String 要创建的里程碑的截止日期（yyyy-mm-dd）
description String 要创建的里程碑描述信息
milestone String 要关闭或删除的里程碑标题或编号，也可用于指定要绑定到 PR 或 issue 的里程碑标题
force Boolean 如果 PR 或 Issue 已有里程碑，且与新的不同，则移除旧的并设置新的
github-token String 用于访问 API 进行里程碑管理的 GitHub Token，默认为 ${{ github.token }}

常见问题

  1. 如何知道要将哪个里程碑绑定到已合并的 PR？

首先，如果 PR 未合并就关闭，将不会对其执行任何操作。PR 合并后，将优先设置为您在输入中指定的里程碑，若未指定则推断要绑定的里程碑。如果没有打开的里程碑将停止操作。如果有多个打开的里程碑，将优先绑定到截止日期最接近 PR 合并日期的里程碑，如果没有找到，则回退到最近创建的里程碑。

  1. 如何知道要将哪个里程碑绑定到已关闭的 issue？

该Action只会为有已合并 PR 修复的已关闭 issue 添加里程碑，否则不会执行任何操作。Issue 将被绑定到与修复它的 PR 完全相同的里程碑，这也意味着如果 PR 绑定里程碑失败也会导致 Issue 绑定里程碑失败。

许可

Licensed under: