开源项目 stale
使用教程
1、项目介绍
stale
是一个用于检测 GitHub 仓库中长时间未更新的 issue 和 pull request 的工具。它可以帮助项目维护者识别并清理那些不再活跃的讨论,从而保持项目的健康和活跃度。
2、项目快速启动
安装
首先,确保你已经安装了 pip
和 git
。然后,通过以下命令安装 stale
:
pip install stale
配置
在项目根目录下创建一个 .github
文件夹,并在其中创建一个 stale.yml
文件,配置示例如下:
daysUntilStale: 60
daysUntilClose: 7
exemptLabels:
- "pinned"
- "security"
staleLabel: "stale"
markComment: >
This issue has been automatically marked as stale because it has not had
recent activity. It will be closed if no further activity occurs. Thank you
for your contributions.
closeComment: >
This issue has been closed because it has been marked as stale for lack of recent activity.
运行
在项目根目录下运行以下命令:
stale
3、应用案例和最佳实践
应用案例
假设你是一个开源项目的维护者,你希望定期清理那些长时间未更新的 issue 和 pull request。通过使用 stale
,你可以轻松实现这一目标。
最佳实践
- 定期运行:建议每周或每月定期运行
stale
,以保持项目的活跃度。 - 自定义配置:根据项目需求,自定义
stale.yml
文件中的参数,如daysUntilStale
和daysUntilClose
。 - 通知机制:在
markComment
和closeComment
中添加适当的通知信息,以便贡献者了解 issue 或 pull request 的状态变化。
4、典型生态项目
stale
可以与其他 GitHub 生态项目结合使用,以提高项目管理的效率。以下是一些典型的生态项目:
- GitHub Actions:通过 GitHub Actions 自动化
stale
的运行,确保定期清理。 - Probot:使用 Probot 扩展
stale
的功能,如添加自定义标签或评论。 - ZenHub:结合 ZenHub 的项目管理功能,更好地跟踪和管理 issue 和 pull request。
通过结合这些生态项目,你可以构建一个更加高效和自动化的开源项目管理流程。