🏷 拉取请求大小标签器

可视化并可选择限制拉取请求的大小

🚀 使用方法

在 .github/workflows 目录下创建一个名为 labeler.yml 的文件，并粘贴以下配置。

[!注意] 请注意，PR 大小标签器默认将任何行的添加、删除或修改视为更改，但你可以使用可选参数进行配置，如 files_to_ignore、ignore_file_deletions 或甚至 ignore_line_deletions。

name: labeler

on: [pull_request]

jobs:
  labeler:
    permissions:
      pull-requests: write
      contents: read
      issues: write
    runs-on: ubuntu-latest
    name: 标记 PR 大小
    steps:
      - uses: codelytv/pr-size-labeler@v1
        with:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          xs_label: 'size/xs'
          xs_max_size: '10'
          s_label: 'size/s'
          s_max_size: '100'
          m_label: 'size/m'
          m_max_size: '500'
          l_label: 'size/l'
          l_max_size: '1000'
          xl_label: 'size/xl'
          fail_if_xl: 'false'
          message_if_xl: >
            此 PR 超过了建议的 1000 行大小。
            请确保你没有在一个 PR 中处理多个问题。
            请注意，此 PR 可能因其大小而被拒绝。
          github_api_url: 'https://api.github.com'
          files_to_ignore: ''

[!提示] 当使用 fork 并且不希望任何 PR 能够执行代码时，将 on: [pull_request] 替换为 on: [pull_request_target]（更多信息：GitHub 文档）。

🎛️ 参数

files_to_ignore 示例

files_to_ignore: 'package-lock.json *.lock'
# 或
files_to_ignore: |
  "package-lock.json"
  "*.lock"
  "docs/*"

贡献

如果你想帮助改进这个项目，请阅读贡献指南。

⚖️ 许可证

MIT