Lock Threads 项目教程

2024-09-25 11:33:50作者：明树来

1. 项目目录结构及介绍

Lock Threads 是一个用于自动锁定 GitHub 上长时间未活动的关闭问题、拉取请求和讨论的 GitHub Action。以下是项目的目录结构及其介绍：

lock-threads/
├── assets/
│   └── ...
├── dist/
│   └── ...
├── src/
│   └── ...
├── .gitignore
├── .nvmrc
├── .prettierignore
├── .prettierrc.yml
├── CHANGELOG.md
├── LICENSE
├── README.md
├── action.yml
├── package-lock.json
└── package.json

assets/: 存放项目相关的静态资源文件。
dist/: 存放编译后的文件。
src/: 存放项目的源代码。
.gitignore: 指定 Git 忽略的文件和目录。
.nvmrc: 指定 Node.js 版本。
.prettierignore: 指定 Prettier 忽略的文件和目录。
.prettierrc.yml: Prettier 配置文件。
CHANGELOG.md: 项目更新日志。
LICENSE: 项目许可证文件。
README.md: 项目介绍和使用说明。
action.yml: GitHub Action 的配置文件。
package-lock.json: 锁定项目依赖的版本。
package.json: 项目的依赖和脚本配置文件。

2. 项目的启动文件介绍

Lock Threads 项目的主要启动文件是 action.yml，它定义了 GitHub Action 的行为和配置。以下是 action.yml 的主要内容：

name: 'Lock Threads'
description: 'GitHub Action that locks closed issues, pull requests and discussions after a period of inactivity'
inputs:
  github-token:
    description: 'GitHub access token'
    required: true
    default: '${{ github.token }}'
  issue-inactive-days:
    description: 'Number of days of inactivity before a closed issue is locked'
    required: false
    default: '365'
  # 其他输入参数...
runs:
  using: 'node16'
  main: 'dist/index.js'

name: 定义了 GitHub Action 的名称。
description: 描述了 GitHub Action 的功能。
inputs: 定义了 GitHub Action 的输入参数，包括 github-token、issue-inactive-days 等。
runs: 定义了 GitHub Action 的运行环境（使用 Node.js 16）和主入口文件 dist/index.js。

3. 项目的配置文件介绍

Lock Threads 项目的主要配置文件是 action.yml，它包含了 GitHub Action 的所有配置选项。以下是一些关键配置项的介绍：

github-token: GitHub 访问令牌，用于访问 GitHub API。
issue-inactive-days: 定义了关闭问题在锁定前的非活动天数，默认值为 365 天。
exclude-issue-created-before: 排除在指定日期之前创建的问题。
exclude-issue-created-after: 排除在指定日期之后创建的问题。
include-any-issue-labels: 仅锁定包含指定标签的问题。
add-issue-labels: 在锁定问题之前添加的标签。
issue-comment: 在锁定问题之前发布的评论。
issue-lock-reason: 锁定问题的原因，可以是 resolved、off-topic、too heated 或 spam。