Lock-Threads 项目教程

1. 项目介绍

Lock-Threads 是一个 GitHub Action，用于自动锁定旧的 GitHub 讨论和拉取请求。它可以帮助维护者管理仓库中的讨论，确保只有活跃的讨论保持开放，从而减少噪音并提高仓库的可维护性。

主要功能

• 自动锁定旧讨论：根据设定的条件（如时间、评论数量等）自动锁定旧的讨论。
• 自定义锁定条件：支持自定义锁定的时间阈值和评论数量阈值。
• 忽略特定标签：可以配置忽略带有特定标签的讨论，确保重要的讨论不会被锁定。
• 通知用户：在锁定讨论时，可以发送通知给相关用户。

2. 项目快速启动

安装步骤

1. 创建 GitHub Action 配置文件： 在你的 GitHub 仓库中，创建一个 .github/workflows/lock-threads.yml 文件，并添加以下内容：

   name: Lock Threads
   
   on:
     schedule:
       - cron: '0 0 * * *'  # 每天午夜运行
   
   jobs:
     lock:
       runs-on: ubuntu-latest
   
       steps:
         - name: Lock threads
           uses: dessant/lock-threads@v3
           with:
             github-token: ${{ secrets.GITHUB_TOKEN }}
             issue-lock-inactive-days: 30  # 锁定超过30天未活动的讨论
             issue-lock-comment: "This thread has been automatically locked due to inactivity."
             pr-lock-inactive-days: 30  # 锁定超过30天未活动的拉取请求
             pr-lock-comment: "This pull request has been automatically locked due to inactivity."
   

2. 配置 GitHub Token： 确保你的仓库中已经配置了 GITHUB_TOKEN，GitHub Action 会自动使用这个 Token 进行操作。

3. 提交并推送配置文件： 将 .github/workflows/lock-threads.yml 文件提交并推送到你的 GitHub 仓库。

4. 查看运行结果： 配置完成后，GitHub Action 会按照你设定的时间表自动运行，锁定符合条件的旧讨论和拉取请求。

3. 应用案例和最佳实践

应用案例

• 开源项目维护：在大型开源项目中，旧的讨论和拉取请求可能会积累很多，使用 Lock-Threads 可以自动清理这些旧的讨论，保持项目的整洁。
• 社区管理：在社区管理的仓库中，使用 Lock-Threads 可以确保只有活跃的讨论保持开放，减少噪音，提高社区的互动质量。

最佳实践

• 合理设置锁定条件：根据项目的实际情况，合理设置 issue-lock-inactive-days 和 pr-lock-inactive-days，避免误锁重要的讨论。
• 自定义锁定通知：通过 issue-lock-comment 和 pr-lock-comment 自定义锁定时的通知信息，告知用户讨论被锁定的原因。
• 定期检查配置：定期检查和更新 GitHub Action 的配置，确保其符合项目的需求。

4. 典型生态项目

• Stale：一个类似的 GitHub Action，用于自动关闭旧的讨论和拉取请求。与 Lock-Threads 不同，Stale 会关闭讨论而不是锁定。
• Reminders：一个 GitHub Action，用于定期提醒仓库维护者处理未解决的讨论和拉取请求。
• Auto-Label：一个 GitHub Action，用于根据讨论内容自动添加标签，帮助分类和管理讨论。

通过结合这些生态项目，可以进一步提高仓库的管理效率和可维护性。